public inbox for kernel-tls-handshake@lists.linux.dev
 help / color / mirror / Atom feed
From: Chuck Lever <cel@kernel.org>
To: <kernel-tls-handshake@lists.linux.dev>
Cc: Xin Long <lucien.xin@gmail.com>, Chuck Lever <chuck.lever@oracle.com>
Subject: [PATCH v1 00/16] Create gh-pages for ktls-utils
Date: Thu, 25 Sep 2025 21:21:49 -0400	[thread overview]
Message-ID: <20250926012207.3642990-1-cel@kernel.org> (raw)

From: Chuck Lever <chuck.lever@oracle.com>

Sorry for the size of this series.

The Doxygen comment style we started with was the kdoc style, which
isn't suitable for user space projects. So the first step is to
convert the comments to bog standard user-space Doxygen.

Patch 13/14 then adds the "create the Doxygen tree" build logic.

Patch 14/14 adds a GitHub action that can generate and deploy a
set of gh-pages for ktls-utils. It includes the man pages, an
example configuration file, and the generated Doxygen tree.

This isn't perfect, but it's something that can be built on over
time.

Chuck Lever (14):
  tlshd: Add kernel's quic.h
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/client.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/config.c
  tlshd: Translate kernel-style Doxygen comments in
    src/tlshd/handshake.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/keyring.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/ktls.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/log.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/main.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/netlink.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/quic.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/server.c
  tlshd: Translate kernel-style Doxygen comments in src/tlshd/tlshd.h
  Build Doxygen web site
  workflows: Generate gh-pages automatically

Xin Long (2):
  tlshd: leave session_status as EIO on GnuTLS failure in QUIC session
    setup
  tlshd: set conn errcode to EACCES on GnuTLS failure in QUIC handshake

 .github/workflows/documentation.yml |  154 ++
 .gitignore                          |    1 +
 Makefile.am                         |    3 +-
 configure.ac                        |   13 +-
 docs/Doxyfile.in                    | 2836 +++++++++++++++++++++++++++
 {src => docs}/Makefile.am           |   13 +-
 src/Makefile.am                     |    2 +
 src/mainpage.c                      |   20 +
 src/tlshd/Makefile.am               |    3 +-
 src/tlshd/client.c                  |  200 +-
 src/tlshd/config.c                  |  164 +-
 src/tlshd/handshake.c               |   32 +-
 src/tlshd/keyring.c                 |   79 +-
 src/tlshd/ktls.c                    |  118 +-
 src/tlshd/log.c                     |  102 +-
 src/tlshd/main.c                    |   42 +-
 src/tlshd/netlink.c                 |  110 +-
 src/tlshd/quic.c                    |  246 ++-
 src/tlshd/quic.h                    |  236 +++
 src/tlshd/server.c                  |  232 ++-
 src/tlshd/tlshd.h                   |   87 +-
 21 files changed, 4343 insertions(+), 350 deletions(-)
 create mode 100644 .github/workflows/documentation.yml
 create mode 100644 docs/Doxyfile.in
 copy {src => docs}/Makefile.am (78%)
 create mode 100644 src/mainpage.c
 create mode 100644 src/tlshd/quic.h

-- 
2.51.0


             reply	other threads:[~2025-09-26  1:22 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-26  1:21 Chuck Lever [this message]
2025-09-26  1:21 ` [PATCH v1 01/16] tlshd: Add kernel's quic.h Chuck Lever
2025-09-26  1:21 ` [PATCH v1 02/16] tlshd: leave session_status as EIO on GnuTLS failure in QUIC session setup Chuck Lever
2025-09-26  1:21 ` [PATCH v1 03/16] tlshd: set conn errcode to EACCES on GnuTLS failure in QUIC handshake Chuck Lever
2025-09-26  1:21 ` [PATCH v1 04/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/client.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 05/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/config.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 06/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/handshake.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 07/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/keyring.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 08/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/ktls.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 09/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/log.c Chuck Lever
2025-09-26  1:21 ` [PATCH v1 10/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/main.c Chuck Lever
2025-09-26  1:22 ` [PATCH v1 11/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/netlink.c Chuck Lever
2025-09-26  1:22 ` [PATCH v1 12/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/quic.c Chuck Lever
2025-09-26  1:22 ` [PATCH v1 13/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/server.c Chuck Lever
2025-09-26  1:22 ` [PATCH v1 14/16] tlshd: Translate kernel-style Doxygen comments in src/tlshd/tlshd.h Chuck Lever
2025-09-26  1:22 ` [PATCH v1 15/16] Build Doxygen web site Chuck Lever
2025-09-26  1:22 ` [PATCH v1 16/16] workflows: Generate gh-pages automatically Chuck Lever

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250926012207.3642990-1-cel@kernel.org \
    --to=cel@kernel.org \
    --cc=chuck.lever@oracle.com \
    --cc=kernel-tls-handshake@lists.linux.dev \
    --cc=lucien.xin@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox