From: Jonathan Corbet <corbet@lwn.net> To: ksummit-discuss@lists.linuxfoundation.org, ksummit@lists.linux.dev Subject: [TECH TOPIC] What kernel documentation could be Date: Fri, 17 Jun 2022 14:57:10 -0600 [thread overview] Message-ID: <87sfo3nh3t.fsf@meer.lwn.net> (raw) The development community has put a lot of work into the kernel's documentation directory in recent years, with visible results. But the kernel's documentation still falls far short of the standard set by many other projects, and there is a great deal of "tribal knowledge" in our community that is not set down. I'd like to look at the successes and failures of the work so far, but intent to focus on a discussion of what our documentation should be and what we can do to get it there. Questions to discuss include: - Bringing an coherent overall structure to Documentation/ - Making it easier for developers to improve the documentation. - What we would like from Sphinx and what we can do to make it happen - Making the docs build system less ugly and more maintainable - Integrating rustdoc documentation jon
WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net> Subject: [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be Date: Fri, 17 Jun 2022 14:57:10 -0600 [thread overview] Message-ID: <87sfo3nh3t.fsf@meer.lwn.net> (raw) Message-ID: <20220617205710.QALI-P3fei6--HyNgkD8H_Vy4lhy8DoJZ0NewhhNAEQ@z> (raw) The development community has put a lot of work into the kernel's documentation directory in recent years, with visible results. But the kernel's documentation still falls far short of the standard set by many other projects, and there is a great deal of "tribal knowledge" in our community that is not set down. I'd like to look at the successes and failures of the work so far, but intent to focus on a discussion of what our documentation should be and what we can do to get it there. Questions to discuss include: - Bringing an coherent overall structure to Documentation/ - Making it easier for developers to improve the documentation. - What we would like from Sphinx and what we can do to make it happen - Making the docs build system less ugly and more maintainable - Integrating rustdoc documentation jon
next reply other threads:[~2022-06-17 20:57 UTC|newest] Thread overview: 65+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-06-17 20:57 Jonathan Corbet [this message] 2022-06-17 20:57 ` [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be Jonathan Corbet 2022-06-17 21:48 ` Laurent Pinchart 2022-06-17 21:48 ` Laurent Pinchart 2022-06-27 15:18 ` Jonathan Corbet 2022-06-18 8:24 ` Mauro Carvalho Chehab 2022-06-18 8:24 ` Mauro Carvalho Chehab 2022-06-18 11:03 ` Miguel Ojeda 2022-06-18 11:16 ` Mauro Carvalho Chehab 2022-06-18 11:16 ` Mauro Carvalho Chehab 2022-06-18 14:37 ` Miguel Ojeda 2022-06-23 9:18 ` Jani Nikula 2022-06-23 9:57 ` Mauro Carvalho Chehab 2022-06-23 10:30 ` Jani Nikula 2022-06-23 13:40 ` Jonathan Corbet 2022-06-24 7:33 ` Mauro Carvalho Chehab 2022-06-24 16:37 ` Markus Heiser 2022-06-27 15:27 ` Jonathan Corbet 2022-06-27 15:31 ` Christoph Hellwig 2022-06-28 7:43 ` Mauro Carvalho Chehab 2022-06-28 7:57 ` Geert Uytterhoeven 2022-06-28 11:01 ` Mauro Carvalho Chehab 2022-07-02 12:43 ` Stephen Rothwell 2022-06-24 22:57 ` Jonathan Corbet 2022-06-25 9:10 ` Mauro Carvalho Chehab 2022-06-25 14:00 ` Jonathan Corbet 2022-06-25 18:11 ` Linus Torvalds 2022-06-26 7:55 ` Mauro Carvalho Chehab 2022-06-26 9:26 ` Mauro Carvalho Chehab 2022-06-26 9:53 ` Mauro Carvalho Chehab 2022-06-27 15:28 ` Liam Howlett 2022-06-27 15:54 ` Christian Brauner 2022-06-27 16:27 ` Mark Brown 2022-06-28 10:53 ` Mauro Carvalho Chehab 2022-06-28 16:13 ` Luck, Tony 2022-06-27 15:34 ` Jonathan Corbet 2022-06-27 17:07 ` Linus Torvalds 2022-07-01 8:48 ` [PATCH 0/4] Address some issues with sphinx detection Mauro Carvalho Chehab 2022-07-01 8:48 ` [PATCH 1/4] scripts: sphinx-pre-install: fix venv version check logic Mauro Carvalho Chehab 2022-07-01 8:48 ` [PATCH 2/4] scripts: sphinx-pre-install: report broken venv Mauro Carvalho Chehab 2022-07-01 8:48 ` [PATCH 3/4] scripts: sphinx-pre-install: check for PDF min version later on Mauro Carvalho Chehab 2022-07-01 8:48 ` [PATCH 4/4] scripts: sphinx-pre-install: provide both venv and package installs Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 0/5] Address some issues with sphinx detection Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 1/5] scripts: sphinx-pre-install: fix venv version check logic Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 2/5] scripts: sphinx-pre-install: report broken venv Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 3/5] scripts: sphinx-pre-install: check for PDF min version later on Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 4/5] scripts: sphinx-pre-install: provide both venv and package installs Mauro Carvalho Chehab 2022-07-02 10:11 ` [PATCH v2 5/5] scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0 Mauro Carvalho Chehab 2022-07-05 4:15 ` [PATCH v2 0/5] Address some issues with sphinx detection Akira Yokosawa 2022-07-06 14:31 ` Akira Yokosawa 2022-07-07 20:33 ` Mauro Carvalho Chehab 2022-07-07 18:45 ` Jonathan Corbet 2022-07-07 20:25 ` Mauro Carvalho Chehab 2022-07-07 20:15 ` Mauro Carvalho Chehab 2022-07-08 11:34 ` Expectation to --no-pdf option (was Re: [PATCH v2 0/5] Address some issues with sphinx detection) Akira Yokosawa 2022-07-08 14:02 ` Jonathan Corbet 2022-07-08 14:59 ` Mauro Carvalho Chehab 2022-07-08 15:27 ` Akira Yokosawa 2022-07-08 23:01 ` Akira Yokosawa 2022-07-09 7:59 ` Mauro Carvalho Chehab 2022-07-11 11:23 ` Akira Yokosawa 2022-08-01 23:30 ` [PATCH v2 0/5] Address some issues with sphinx detection Tomasz Warniełło 2022-07-02 10:52 ` [Ksummit-discuss] [TECH TOPIC] What kernel documentation could be Mauro Carvalho Chehab 2022-06-25 17:43 ` Steven Rostedt 2022-06-25 17:48 ` Laurent Pinchart
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=87sfo3nh3t.fsf@meer.lwn.net \ --to=corbet@lwn.net \ --cc=ksummit-discuss@lists.linuxfoundation.org \ --cc=ksummit@lists.linux.dev \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.