Documentation/doc-guide/contributing.rst

1 .. SPDX-License-Identifier: GPL-2.0
6 Documentation is an important part of any software-development project.
8 developers work more effectively.  Without top-quality documentation, a lot
9 of time is wasted in reverse-engineering the code and making avoidable
23 ---------------------------
36 ones.  For this reason, eliminating warnings is one of the highest-priority
59   	- Resource-managed devfreq_register_notifier()
61 	- Resource-managed devfreq_unregister_notifier()
70 	  - Resource-managed devfreq_register_notifier()
89   resulting in these doc-build warnings:
92   	  - Resource-managed devfreq_register_notifier()
94 	  - Resource-managed devfreq_unregister_notifier()
98   Signed-off-by: Jonathan Corbet <corbet@lwn.net>
99   ---
100    drivers/devfreq/devfreq.c | 4 ++--
101    1 file changed, 2 insertions(+), 2 deletions(-)
103   diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
105   --- a/drivers/devfreq/devfreq.c
107   @@ -1814,7 +1814,7 @@ static void devm_devfreq_notifier_release(struct device *dev, void *res)
111   -	- Resource-managed devfreq_register_notifier()
112   + *	- Resource-managed devfreq_register_notifier()
116   @@ -1850,7 +1850,7 @@ EXPORT_SYMBOL(devm_devfreq_register_notifier);
120   -	- Resource-managed devfreq_unregister_notifier()
121   + *	- Resource-managed devfreq_unregister_notifier()
125   --
130 always check linux-next to see if a problem has been fixed before you dig
147 generate links to that documentation.  Adding ``kernel-doc`` directives to
151 The ``scripts/find-unused-docs.sh`` tool can be used to find these
172  - Both American and British English spellings are allowed within the
176  - The question of whether a period should be followed by one or two spaces
179    off-topic here.
197  - References to 2.x kernels
198  - Pointers to SourceForge repositories
199  - Nothing but typo fixes in the history for several years
200  - Discussion of pre-Git workflows
223 That way, at least our long-suffering readers have been warned that the
229 The old-timers around here will remember the Linux books that showed up on
231 files scrounged from various locations on the net.  The books have (mostly)
233 on that model.  It is thousands of files, almost each of which was written
241  - Documentation/admin-guide/index.rst
242  - Documentation/core-api/index.rst
243  - Documentation/driver-api/index.rst
244  - Documentation/userspace-api/index.rst
250 though.  Moving documentation files creates short-term pain for the people
251 who work with those files; they are understandably unenthusiastic about
264 With the adoption of Sphinx we have much nicer-looking HTML output than we
273 Non-LaTeX PDF build