| /linux/Documentation/rust/ |
| H A D | coding-guidelines.rst | 18 .. note:: Conventions on comments and documentation are not checked by
114 empty comment. Thus, at some point, the goal is to remove those comments.
120 "Normal" comments (i.e. ``//``, rather than code documentation which starts
122 comments are, even though they will not be rendered. This improves consistency,
124 comments more easily. For instance:
131 Furthermore, just like documentation, comments are capitalized at the beginning
133 includes ``// SAFETY:``, ``// TODO:`` and other "tagged" comments, e.g.:
139 Comments should not be used for documentation purposes: comments are intended
142 sometimes it is useful to use both comments and documentation at the same time.
144 For the latter case, comments can be inserted in the middle; that is, closer to
[all …]
|
| /linux/Documentation/doc-guide/ |
| H A 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/Documentation/translations/zh_CN/doc-guide/ |
| H A D | contributing.rst | 70 [PATCH] PM / devfreq: Fix two malformed kerneldoc comments
72 Two kerneldoc comments in devfreq.c fail to adhere to the required format,
|
| /linux/Documentation/process/ |
| H A 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
|
| H A 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
|
| H A D | maintainer-kvm-x86.rst | 118 Except for a handful of special snowflakes, do not use kernel-doc comments for
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
|
| /linux/Documentation/driver-api/ |
| H A D | target.rst | 13 This section is blank because no kerneldoc comments have been added to
|
| /linux/tools/bpf/bpftool/Documentation/ |
| H A D | Makefile | 21 RST2MAN_OPTS += --verbose --strip-comments
|
| /linux/Documentation/bpf/libbpf/ |
| H A 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/tools/lib/python/feat/ |
| H A D | parse_features.py | 116 comments = ""
171 comments += match.group(1)
213 "comments": comments,
320 com = self.data[feat]["comments"].strip()
|
| /linux/Documentation/translations/ko_KR/ |
| H A D | stable_api_nonsense.txt | 10 a fork. So if you have any comments or updates for this file please
|
| /linux/arch/arm64/boot/dts/allwinner/ |
| H A D | sun50i-h6-orangepi-lite2.dts | 53 * See the comments for CLDO2.
|
| /linux/Documentation/translations/ja_JP/ |
| H A D | stable_api_nonsense.txt | 11 fork. So if you have any comments or updates of this file, please try
|
| /linux/arch/arm/nwfpe/ |
| H A D | fpa11.inl | 5 Direct questions, comments to Scott Bambrough <scottb@netwinder.org>
|
| H A D | fpmodule.inl | 5 Direct questions, comments to Scott Bambrough <scottb@netwinder.org>
|
| /linux/Documentation/admin-guide/nfs/ |
| H A D | nfsd-admin-interfaces.rst | 33 fs/nfsd/nfsctl.c; most of them have detailed comments.
|
| /linux/Documentation/fb/ |
| H A D | cirrusfb.rst | 58 * Code cleanup, add comments.
|
| /linux/Documentation/filesystems/ext4/ |
| H A D | about.rst | 14 e2fsprogs-1.44. All comments and corrections are welcome, since there is
|
| /linux/drivers/net/ethernet/3com/ |
| H A D | Kconfig | 36 and in the comments at the beginning of
|
| /linux/Documentation/netlabel/ |
| H A D | introduction.rst | 38 names can be found in the 'net/netlabel/' directory as comments in the
|
| /linux/rust/ |
| H A D | bindgen_parameters | 27 --no-doc-comments
|
| /linux/drivers/message/fusion/lsi/ |
| H A D | mpi_history.txt | 128 * Added structure offset comments.
270 * Added structure offset comments.
536 * 03-27-01 01.01.04 Added structure offset comments.
587 * 03-27-01 01.01.04 Added structure offset comments.
637 * Added structure offset comments.
662 * 03-27-01 01.01.03 Added structure offset comments.
670 * 03-27-01 01.01.02 Added structure offset comments.
|
| /linux/Documentation/userspace-api/media/v4l/ |
| H A D | vidioc-g-jpegcomp.rst | 48 information for in an AVI or so). COM is the same, but it's comments,
|
| /linux/Documentation/input/devices/ |
| H A D | cs461x.rst | 31 comments about them; but I've found the joystick can be initialized
|
| /linux/Documentation/watchdog/ |
| H A D | pcwd-watchdog.rst | 49 WDIOF_* bitwise-anded into the value. (The comments
|