- 09 Mar, 2021 14 commits
-
-
Randy Dunlap authored
Fix a typo (supportinf -> supporting). Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com> Cc: linux-input@vger.kernel.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Link: https://lore.kernel.org/r/20210302223523.20130-9-rdunlap@infradead.orgSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Randy Dunlap authored
Drop a repeated word. Fix punctuation of "eg." to "e.g." Fix punctuation of "ie" to "i.e." Add hyphentation to non-zero. Capitalize PM (for Power Management). Capitalize ID (for Identifier). Change "," in a run-on sentence to ";". Signed-off-by:
-
Randy Dunlap authored
Add 'ledstate' to the keyboard_notifier_param struct info and tell which header file contains that struct. Signed-off-by:
-
Randy Dunlap authored
Correct hyphenation, spelling, and capitalization. Signed-off-by:
-
Randy Dunlap authored
Use "E.g." instead of "Eg.". Use correct index for buttons[] array. Update all of struct gameport's descriptions. Signed-off-by:
-
Randy Dunlap authored
Change other related documentation file names from .txt to .rst and be more explicit about their paths/locations. Signed-off-by:
-
Randy Dunlap authored
Fix hyphenation, typos, capitalization, and a referenced file name (.txt -> .rst). Signed-off-by:
-
Randy Dunlap authored
Fix grammar, punctuation, and spelling. Signed-off-by:
-
Mauro Carvalho Chehab authored
When anonymous enums are used, the identifier is empty. While, IMO, it should be avoided the usage of such enums, adding support for it is not hard. So, postpone the check for empty identifiers to happen only at the dump phase. Signed-off-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/055ad57879f1b9381b90879e00f72fde1c3a5647.1614760910.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Martin Kepplinger authored
dynamic debug is "expecting pairs of match-spec <value>" so the example for all files of which the paths include "usb" there is "file" missing. Signed-off-by:
Martin Kepplinger <martin.kepplinger@puri.sm> Link: https://lore.kernel.org/r/20210303091646.773111-1-martin.kepplinger@puri.smSigned-off-by:
-
Geert Uytterhoeven authored
Add a paragraph about the ATTRIBUTE_GROUPS() helper macro, and use it in the example. Retain the old description, as it is still useful in case of multiple groups. Change the names of the group(s) structures, to match the ATTRIBUTE_GROUPS() macro. Signed-off-by:
Geert Uytterhoeven <geert+renesas@glider.be> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Link: https://lore.kernel.org/r/20210303133845.3939403-3-geert+renesas@glider.beSigned-off-by:
-
Geert Uytterhoeven authored
bus.rst, driver.rst, and hwmon-kernel-api.rst refer to the DEVICE_ATTR_* macros for devices, but device.rst does not mention them. Add a paragraph about these helper macros, and use them in the examples. Retain the old description, as it is still useful for less common values of mode. Change the names of the example "show" and "store" methods, to match the expectations of the DEVICE_ATTR_* macros. Signed-off-by:
-
Wu XiangCheng authored
Add translation zh_CN/admin-guide/unicode.rst, and link it to zh_CN/admin-guide/index.rst while clean its todo entry. Signed-off-by:
Wu XiangCheng <bobwxc@email.cn> Reviewed-by:
Alex Shi <alex.shi@linux.alibaba.com> Link: https://lore.kernel.org/r/20210304080148.GA16612@mipcSigned-off-by:
-
Wu XiangCheng authored
Add translation zh_CN/admin-guide/README.rst, and link it to zh_CN/admin-guide/index.rst while clean its todo entry. Signed-off-by:
-
- 08 Mar, 2021 11 commits
-
-
hjh authored
Signed-off-by:
hjh <huangjianghui@uniontech.com> Reviewed-by:
-
Aditya Srivastava authored
Currently, kernel-doc warns for function prototype parsing on the presence of attributes "__attribute_const__" and "__flatten" in the definition. There are 166 occurrences in ~70 files in the kernel tree for "__attribute_const__" and 5 occurrences in 4 files for "__flatten". Out of 166, there are 3 occurrences in three different files with "__attribute_const__" and a preceding kernel-doc; and, 1 occurrence in ./mm/percpu.c for "__flatten" with a preceding kernel-doc. All other occurrences have no preceding kernel-doc. Add support for "__attribute_const__" and "__flatten" attributes. A quick evaluation by running 'kernel-doc -none' on kernel-tree reveals that no additional warning or error has been added or removed by the fix. Suggested-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by:
Aditya Srivastava <yashsri421@gmail.com> Link: https://lore.kernel.org/r/20210306113510.31023-1-yashsri421@gmail.comSigned-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/8.Conclusion.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/7.AdvancedTopics.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/6.Followthrough.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/5.Posting.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/4.Coding.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/3.Early-stage.rst Signed-off-by:
-
Wu XiangCheng authored
Sync and improve language & grammar of zh_CN/process/2.Process.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/1.Intro.rst Signed-off-by:
-
Wu XiangCheng authored
Improve language and grammar of zh_CN/process/index.rst Signed-off-by:
-
- 07 Mar, 2021 15 commits
-
-
Heinrich Schuchardt authored
Add missing items to table of parameters set in the /chosen node by the EFI stub. Signed-off-by:
Heinrich Schuchardt <xypron.glpk@gmx.de> Link: https://lore.kernel.org/r/20210206084120.43305-1-xypron.glpk@gmx.deSigned-off-by:
-
Randy Dunlap authored
Add fs/eventpoll.c to the filesystem api-summary book. Signed-off-by:
-
Randy Dunlap authored
Use the documented kernel-doc format for function Return: descriptions. Begin constant values in kernel-doc comments with '%'. Remove kernel-doc "/**" from 2 functions that are not documented with kernel-doc notation. Fix typos, punctuation, & grammar. Also fix a few kernel-doc warnings: ../fs/eventpoll.c:1883: warning: Function parameter or member 'ep' not described in 'ep_loop_check_proc' ../fs/eventpoll.c:1883: warning: Excess function parameter 'priv' description in 'ep_loop_check_proc' ../fs/eventpoll.c:1932: warning: Function parameter or member 'ep' not described in 'ep_loop_check' ../fs/eventpoll.c:1932: warning: Excess function parameter 'from' description in 'ep_loop_check' Signed-off-by:
-
Randy Dunlap authored
All userspace ioctls major/magic number should be documented in Documentation/userspace-api/ioctl/ioctl-number.rst, so add the entry for <linux/nsfs.h>. Signed-off-by:
-
Kees Cook authored
As started by commit 05a5f51c ("Documentation: Replace lkml.org links with lore"), replace a few more scattered lkml.org links with lore to better use a single source that's more likely to stay available long-term. Signed-off-by:
Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20210210234005.2236201-1-keescook@chromium.orgSigned-off-by:
-
Lubomir Rintel authored
MMP2 is used in XO-1.75 and MMP3 is now supported in mainline. Signed-off-by:
Lubomir Rintel <lkundrak@v3.sk> Link: https://lore.kernel.org/r/20210215220839.423709-4-lkundrak@v3.skSigned-off-by:
-
Lubomir Rintel authored
Marvell has an annoying habit of moving stuff around their web site every full moon, and often just removing documents altogether. At this point basically none but four of the links still works and even those that work today weren't working for a long period of time previously. That is a shame because (short of the product briefs) the documents tend to be quite useful. Let's replace them with known working versions of IA's Wayback Machine links. That seems to be about the only way of getting a URL that's going to work the next week. Signed-off-by:
-
Borislav Petkov authored
Add more blurb about the level of detail that should be contained in a patch's commit message. Extend and make more explicit what text should be added under the --- line. Extend examples and split into more easily palatable paragraphs. This has been partially carved out from a tip subsystem handbook patchset by Thomas Gleixner: https://lkml.kernel.org/r/20181107171010.421878737@linutronix.de and incorporates follow-on comments. Signed-off-by:
Borislav Petkov <bp@suse.de> Reviewed-by:
Robert Richter <rrichter@amd.com> Link: https://lore.kernel.org/r/20210215141949.GB21734@zn.tnic [jc: Tweaked "example subjects" wording] Signed-off-by:
-
Thorsten Leemhuis authored
Replace placeholder text about decoding stack traces with a section that properly describes what a typical user should do these days. To make it works for them, add a paragraph in an earlier section to ensure people build their kernels with everything that's needed to decode stack traces later. Signed-off-by:
Thorsten Leemhuis <linux@leemhuis.info> Reviewed-by:
Qais Yousef <qais.yousef@arm.com> Acked-by:
Vlastimil Babka <vbabka@suse.cz> Link: https://lore.kernel.org/r/20210215172857.382285-1-linux@leemhuis.infoSigned-off-by:
-
Lukas Bulwahn authored
As discussed, Dwaipayan and Lukas take the responsibility for maintaining the checkpatch documentation that is currently being built up. To be sure that the checkpatch maintainers and the corresponding documentation maintainers can keep the content synchronized, add them as reviewers to the counterpart. Signed-off-by:
Dwaipayan Ray <dwaipayanray1@gmail.com> Link: https://lore.kernel.org/lkml/bcee822d1934772f47702ee257bc735c8f467088.camel@perches.com/ Link: https://lore.kernel.org/r/20210226093827.12700-4-dwaipayanray1@gmail.comSigned-off-by:
-
Dwaipayan Ray authored
Add a new verbose mode to checkpatch.pl to emit additional verbose test descriptions. The verbose mode is optional and can be enabled by the flag -v or --verbose. The test descriptions are parsed from the checkpatch documentation file at `Documentation/dev-tools/checkpatch.rst`. The test descriptions in the docs are kept in a fixed format grouped by usage. Some examples of this format are: **LINE_SPACING** Vertical space is wasted given the limited number of lines an editor window can display when multiple blank lines are used. **MISSING_SIGN_OFF** The patch is missing a Signed-off-by line. A signed-off-by line should be added according to Developer's certificate of Origin. To avoid lengthy output, the verbose description is printed only for the first instance of a particular message type. The --verbose option cannot be used along with the --terse option. Verbose mode can be used with the --list-types option. The --list-types output also supports color coding now. Signed-off-by: -
Dwaipayan Ray authored
Add documentation for kernel script checkpatch.pl. This documentation is also parsed by checkpatch to enable a verbose mode. The checkpatch message types are grouped by usage. Under each group the types are described briefly. 34 of such types are documented. Signed-off-by:
-
Flavio Suligoi authored
The file linux/pcwd.h is not more present in the kernel sources. Its information is now moved into the file: include/uapi/linux/watchdog.h Signed-off-by:
Flavio Suligoi <f.suligoi@asem.it> Link: https://lore.kernel.org/r/20210223111324.309285-1-f.suligoi@asem.itSigned-off-by:
-
Geert Uytterhoeven authored
None of this is valid since v2.5.69. Signed-off-by:
-
Aditya Srivastava authored
Currently, there are ~1290 occurrences in 447 files in the kernel tree 'typedef struct/union' syntax for defining some struct/union. However, kernel-doc currently does not support that syntax. Of the ~1290 occurrences, there are four occurrences in ./include/linux/zstd.h with typedef struct/union syntax and a preceding kernel-doc; all other occurrences have no preceding kernel-doc. Add support for parsing struct/union following this syntax. Signed-off-by:
-
