($INBOX_DIR/description missing)
 help / color / mirror / Atom feed
From: Cyril Hrubis <chrubis@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [PATCH v3 0/2] doc: Add generated API docs
Date: Wed,  3 Apr 2024 10:26:16 +0200	[thread overview]
Message-ID: <20240403082618.5829-1-chrubis@suse.cz> (raw)

This applies over the new doc patchset from Andrea and converts
documentation in headers into a linuxdoc format.

This is a v2 with spelling fixes hopefully all the easily caught
mistakes are fixed now.

If you have a bit of time please read the changes through and report any
problems.

V3: Removed the unused tst_compiler.h
V2: Spell checks

Cyril Hrubis (2):
  doc: Add more to spelling_wordlist
  include: doc: Convert comments into linuxdoc

 doc_new/developers/api_c_tests.rst |  26 ++
 doc_new/spelling_wordlist          |  40 +++
 include/tst_buffers.h              |  86 +++--
 include/tst_capability.h           |  80 ++++-
 include/tst_checkpoint.h           |  64 +++-
 include/tst_hugepage.h             |   2 +
 include/tst_parse.h                |  65 ++++
 include/tst_res_flags.h            |  72 +++-
 include/tst_test.h                 | 509 +++++++++++++++++++++--------
 9 files changed, 742 insertions(+), 202 deletions(-)
 create mode 100644 include/tst_parse.h

-- 
2.43.2


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

             reply	other threads:[~2024-04-03  8:27 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-03  8:26 Cyril Hrubis [this message]
2024-04-03  8:26 ` [LTP] [PATCH v3 1/2] doc: Add more to spelling_wordlist Cyril Hrubis
2024-04-04 12:38   ` Petr Vorel
2024-04-03  8:26 ` [LTP] [PATCH v3 2/2] include: doc: Convert comments into linuxdoc Cyril Hrubis
2024-04-04 12:51   ` Petr Vorel
2024-04-04 12:55     ` Cyril Hrubis
2024-04-04 13:42       ` Petr Vorel

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=20240403082618.5829-1-chrubis@suse.cz \
    --to=chrubis@suse.cz \
    --cc=ltp@lists.linux.it \
    /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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).