linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: kernel@collabora.com, linux-doc@vger.kernel.org,
	 linux-kernel@vger.kernel.org,
	 Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
Subject: [PATCH 0/2] Add linked list documentation, and also documentation documentation
Date: Tue, 20 May 2025 17:57:13 +0200	[thread overview]
Message-ID: <20250520-linked-list-docs-v1-0-db74f7449785@collabora.com> (raw)

This series started out with a much more ambitious goal of documenting
every undocumented generic kernel data structure. About 6 hours in I had
to tell myself that maybe it's better to do this piece-meal. So here is
the first of what will hopefully be many similar series: documenting
linked lists.

It starts out with a mostly unrelated docs patch for sphinx usage,
because I couldn't help myself.

The main patch follows, which is to add some rudimentary documentation
for linked lists, to test the waters on how receptive the community is
towards this type of documentation.

Should this style of documentation be seen as acceptable or even wanted,
then I'll continue in subsequent series to expand both this document,
and move on to other underdocumented data structures, such as
hashtables.

Based against lwn/docs-next, but b4 should let you know already.

Signed-off-by: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
---
Nicolas Frattaroli (2):
      docs: Document how to use the recommended docs theme
      docs: document linked lists

 Documentation/core-api/index.rst   |   1 +
 Documentation/core-api/list.rst    | 390 +++++++++++++++++++++++++++++++++++++
 Documentation/doc-guide/sphinx.rst |   3 +-
 3 files changed, 393 insertions(+), 1 deletion(-)
---
base-commit: a556bd882b9482f1b7ea00fcf07f9bc169f404c8
change-id: 20250520-linked-list-docs-ce5b956d4602

Best regards,
-- 
Nicolas Frattaroli <nicolas.frattaroli@collabora.com>


             reply	other threads:[~2025-05-20 15:57 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-20 15:57 Nicolas Frattaroli [this message]
2025-05-20 15:57 ` [PATCH 1/2] docs: Document how to use the recommended docs theme Nicolas Frattaroli
2025-05-20 16:14   ` Randy Dunlap
2025-05-20 17:48     ` Nicolas Frattaroli
2025-05-20 15:57 ` [PATCH 2/2] docs: document linked lists Nicolas Frattaroli
2025-05-20 16:53   ` Randy Dunlap
2025-06-09 21:20   ` Jonathan Corbet
2025-06-16  7:01     ` Nicolas Frattaroli

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=20250520-linked-list-docs-v1-0-db74f7449785@collabora.com \
    --to=nicolas.frattaroli@collabora.com \
    --cc=corbet@lwn.net \
    --cc=kernel@collabora.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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 NNTP newsgroup(s).