Lines Matching +full:look +full:- +full:up
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
42 positives, leading to patches aimed at simply shutting the compiler up.
59 - Resource-managed devfreq_register_notifier()
61 - Resource-managed devfreq_unregister_notifier()
65 A quick look at the source file named above turned up a couple of kerneldoc
66 comments that look like this::
70 - Resource-managed devfreq_register_notifier()
78 simplistic idea of what C comment blocks look like. This problem had been
80 it was a matter of adding the missing asterisks. A quick look at the
88 resulting in these doc-build warnings:
91 - Resource-managed devfreq_register_notifier()
93 - Resource-managed devfreq_unregister_notifier()
97 Signed-off-by: Jonathan Corbet <corbet@lwn.net>
98 ---
99 drivers/devfreq/devfreq.c | 4 ++--
100 1 file changed, 2 insertions(+), 2 deletions(-)
102 diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
104 --- a/drivers/devfreq/devfreq.c
106 @@ -1814,7 +1814,7 @@ static void devm_devfreq_notifier_release(struct device *dev, void *res)
110 - - Resource-managed devfreq_register_notifier()
111 + * - Resource-managed devfreq_register_notifier()
115 @@ -1850,7 +1850,7 @@ EXPORT_SYMBOL(devm_devfreq_register_notifier);
119 - - Resource-managed devfreq_unregister_notifier()
120 + * - Resource-managed devfreq_unregister_notifier()
124 --
129 always check linux-next to see if a problem has been fixed before you dig
146 generate links to that documentation. Adding ``kernel-doc`` directives to
150 The ``scripts/find-unused-docs.sh`` tool can be used to find these
171 - Both American and British English spellings are allowed within the
175 - The question of whether a period should be followed by one or two spaces
178 off-topic here.
196 - References to 2.x kernels
197 - Pointers to SourceForge repositories
198 - Nothing but typo fixes in the history for several years
199 - Discussion of pre-Git workflows
222 That way, at least our long-suffering readers have been warned that the
228 The old-timers around here will remember the Linux books that showed up on
240 - :doc:`../admin-guide/index`
241 - :doc:`../core-api/index`
242 - :doc:`../driver-api/index`
243 - :doc:`../userspace-api/index`
249 though. Moving documentation files creates short-term pain for the people
263 With the adoption of Sphinx we have much nicer-looking HTML output than we
272 Non-LaTeX PDF build
282 for PDF generation, but it turned out to not be up to the task.
283 Development work on rst2pdf seems to have picked up again in recent times,