linux/Documentation/doc-guide
Joe Stringer 35d4a3c67e docs/doc-guide: Clarify how to write tables
Prior to this commit, the kernel docs writing guide spent over a page
describing exactly how *not* to write tables into the kernel docs,
without providing a example about the desired format.

This patch provides a positive example first in the guide so that it's
harder to miss, then leaves the existing less desirable approach below
for contributors to follow if they have some stronger justification for
why to use that approach.

Signed-off-by: Joe Stringer <joe@isovalent.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230424171850.3612317-1-joe@isovalent.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-06-09 01:57:56 -06:00
..
contributing.rst Documentation/process: use scripts/get_maintainer.pl on patches 2022-05-09 16:12:16 -06:00
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst Add a maintainer entry profile for documentation 2020-01-24 09:48:39 -07:00
kernel-doc.rst docs: add Rust documentation 2022-09-28 09:02:45 +02:00
maintainer-profile.rst docs: fix broken references for ReST files that moved around 2020-04-20 15:45:03 -06:00
parse-headers.rst A handful of late-arriving docs fixes, along with a patch changing a lot of 2020-06-10 14:12:15 -07:00
sphinx.rst docs/doc-guide: Clarify how to write tables 2023-06-09 01:57:56 -06:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00