| /linux-6.14.4/drivers/staging/gpib/ |
| D | TODO | 4 - tidy-up comments:
5 - there are some "//comments" and "// comments" scattered around
7 - sometimes "// comments" are interleaved with "/* comments */"
8 - multiline comments should start with initial almost-blank line:
|
| /linux-6.14.4/Documentation/doc-guide/ |
| D | kernel-doc.rst | 1 .. title:: Kernel-doc comments
4 Writing kernel-doc comments
8 comments in the kernel-doc format to describe the functions, types
15 comments. Please stick to the style described here.
20 The kernel-doc structure is extracted from the comments, and proper
30 to be used by modules should also have kernel-doc comments.
39 How to format kernel-doc comments
42 The opening comment mark ``/**`` is used for kernel-doc comments. The
43 ``kernel-doc`` tool will extract comments marked this way. The rest of
47 The function and type kernel-doc comments should be placed just before
[all …]
|
| D | contributing.rst | 50 problems in kerneldoc comments in C code. While the documentation
66 comments that look like this::
86 [PATCH] PM / devfreq: Fix two malformed kerneldoc comments
88 Two kerneldoc comments in devfreq.c fail to adhere to the required format,
145 Languishing kerneldoc comments
148 Developers are encouraged to write kerneldoc comments for their code, but
149 many of those comments are never pulled into the docs build. That makes
152 the documentation to bring those comments in can help the community derive
156 overlooked comments.
160 kerneldoc comments for internal use; those should not be pulled into the
|
| /linux-6.14.4/Documentation/rust/ |
| D | coding-guidelines.rst | 18 .. note:: Conventions on comments and documentation are not checked by
42 Comments chapter
45 "Normal" comments (i.e. ``//``, rather than code documentation which starts
47 comments are, even though they will not be rendered. This improves consistency,
49 comments more easily. For instance:
56 Furthermore, just like documentation, comments are capitalized at the beginning
58 includes ``// SAFETY:``, ``// TODO:`` and other "tagged" comments, e.g.:
64 Comments should not be used for documentation purposes: comments are intended
67 sometimes it is useful to use both comments and documentation at the same time.
69 For the latter case, comments can be inserted in the middle; that is, closer to
[all …]
|
| /linux-6.14.4/drivers/net/wireless/realtek/rtlwifi/rtl8192ee/ |
| D | pwrseq.h | 43 /* comments here */ \
69 /* comments here */ \
86 /* comments here */ \
107 /* comments here */ \
121 /* comments here */ \
148 /* comments here */ \
168 /* comments here */ \
179 /* comments here */ \
187 /* comments here */ \
231 /* comments here */ \
[all …]
|
| /linux-6.14.4/Documentation/process/ |
| D | maintainer-tip.rst | 482 Sentences in comments start with an uppercase letter.
484 Single line comments::
488 Multi-line comments::
494 * Larger multi-line comments should be split into paragraphs.
497 No tail comments (see below):
499 Please refrain from using tail comments. Tail comments disturb the
507 Use freestanding comments instead::
518 Use C++ style, tail comments when documenting structs in headers to
548 Comments should be added where the operation is not obvious. Documenting
560 Instead, comments should explain the non-obvious details and document
[all …]
|
| D | 6.Followthrough.rst | 25 A patch of any significance will result in a number of comments from other
61 What all of this comes down to is that, when reviewers send you comments,
64 from happening. When you get review comments on a patch, take the time to
85 One fatal mistake is to ignore review comments in the hope that they will
87 responded to the comments you got the time before, you're likely to find
131 there's a good chance that you will get more comments from a new set of
132 reviewers; these comments need to be answered as in the previous round.
152 may be a new round of comments from developers who had not been aware of
|
| D | submitting-patches.rst | 310 Respond to review comments
313 Your patch will almost certainly get comments from reviewers on ways in
315 respond to those comments; ignoring reviewers is a good way to get ignored in
316 return. You can simply reply to their emails to answer their comments. Review
317 comments or questions that do not lead to a code change should almost certainly
369 receive comments within a few weeks (typically 2-3); if that does not
497 provided such comments, you may optionally add a ``Cc:`` tag to the patch.
570 with the submitter's response to my comments.
653 - Any additional comments not suitable for the changelog.
692 comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for
[all …]
|
| D | maintainer-kvm-x86.rst | 118 Except for a handful of special snowflakes, do not use kernel-doc comments for
123 Comments section in Development
125 Write comments using imperative mood and avoid pronouns. Use comments to
128 speak for itself. If the code itself is inscrutable, comments will not help.
138 not in comments. Instead, if necessary (see below), copy-paste the relevant
143 APM in comments. With few exceptions, KVM *must* honor architectural behavior,
253 modify comments. When possible and relevant, testing on both Intel and AMD is
|
| D | 4.Coding.rst | 366 specially-formatted comments; these comments can be extracted and formatted
368 a subsystem which has kerneldoc comments, you should maintain them and add
371 comments for the future; indeed, this can be a useful activity for
372 beginning kernel developers. The format of these comments, along with some
377 note that, often, comments are most notable by their absence. Once again,
381 comments explaining the more subtle aspects.
|
| D | code-of-conduct.rst | 33 * Trolling, insulting/derogatory comments, and personal or political attacks
49 comments, commits, code, wiki edits, issues, and other contributions that are
|
| /linux-6.14.4/drivers/net/wireless/realtek/rtlwifi/rtl8723be/ |
| D | pwrseq.h | 41 /* comments here */ \
112 /* comments here */ \
144 /* comments here */ \
171 /* comments here */ \
191 /* comments here */ \
218 /* comments here */ \
244 /* comments here */ \
262 /* comments here */ \
270 /* comments here */ \
314 /* comments here */ \
[all …]
|
| /linux-6.14.4/drivers/staging/rtl8723bs/include/ |
| D | hal_pwr_seq.h | 41 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
67 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
80 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
91 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
111 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
123 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
131 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
149 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
165 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
192 /* { offset, cut_msk, fab_msk|interface_msk, base|cmd, msk, value }, comments here*/ \
[all …]
|
| /linux-6.14.4/tools/net/sunrpc/xdrgen/ |
| D | xdrgen | 52 help="Add annotation comments",
77 help="Add annotation comments",
106 help="Add annotation comments",
|
| D | README | 92 By default, the only comments added to this code are kdoc comments
95 additional comments in the generated code to help readers match the
|
| /linux-6.14.4/Documentation/devicetree/bindings/regulator/ |
| D | rohm,bd71815-regulator.yaml | 57 comments below for bucks/LDOs which support this. 0 means
77 comments below for bucks/LDOs which support this. 0 means
86 comments below for bucks/LDOs which support this. 0 means
|
| /linux-6.14.4/Documentation/devicetree/bindings/ |
| D | .yamllint | 26 comments:
29 comments-indentation: disable
|
| /linux-6.14.4/scripts/ |
| D | find-unused-docs.sh | 5 # This script detects files with kernel-doc comments for exported functions
35 echo "The following files contain kerneldoc comments for exported functions \
|
| D | get_feat.pl | 114 my $comments = "";
158 $comments .= "$1\n";
202 $data{$name}->{comments} = $comments;
313 my $com = $data{$feat}->{comments};
317 print "Comments\n";
|
| /linux-6.14.4/scripts/coccinelle/misc/ |
| D | returnvar.cocci | 8 // Comments: Comments on code can be deleted if near code that is removed.
|
| /linux-6.14.4/Documentation/bpf/libbpf/ |
| D | libbpf_naming_convention.rst | 148 The libbpf API is documented via comments above definitions in
149 header files. These comments can be rendered by doxygen and sphinx
151 convention in which these comments should be formatted.
|
| /linux-6.14.4/Documentation/gpu/ |
| D | introduction.rst | 59 concepts. Documentation should be put into the code itself as kerneldoc comments
64 have formal kerneldoc comments. Use normal C comments if you feel like a comment
67 anything entirely private with ``/* private: */`` comments as per the
|
| /linux-6.14.4/arch/powerpc/tools/ |
| D | head_check.sh | 61 echo "ERROR: see comments in arch/powerpc/tools/head_check.sh" 1>&2
75 echo "ERROR: see comments in arch/powerpc/tools/head_check.sh" 1>&2
|
| /linux-6.14.4/rust/kernel/ |
| D | transmute.rs | 19 // SAFETY: Safety comments written in the macro invocation.
54 // SAFETY: Safety comments written in the macro invocation.
|
| /linux-6.14.4/block/ |
| D | bfq-iosched.h | 102 /* head-of-line entity (see comments above) */
347 * queue it is deemed as soft real-time (see the comments on
389 * the comments on the choice of the queue for injection in
526 * weight-raised @bfq_queue (see the comments to the functions
541 * For a detailed explanation see comments on the computation
738 * a burst of activations, see the comments on the function
760 * details in the comments on the function bfq_handle_burst).
813 * Depth limits used in bfq_limit_depth (see comments on the
874 * see comments to bfq_handle_burst.
987 * (see the comments to the function
[all …]
|