- 08 3月, 2018 13 次提交
-
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it into Sphinx TOC tree. No essential content change. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
Add ftrace-uses.rst into Sphinx TOC tree. Few format issues are fixed. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. This documentation is not synced with current code, so mark it as out of date. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Changbin Du 提交于
This just add a index.rst for trace subsystem. More docs will be added later. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: NChangbin Du <changbin.du@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aaro Koskinen 提交于
Add my name to kernel driver statement. Signed-off-by: NAaro Koskinen <aaro.koskinen@iki.fi> Acked-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Tobin C. Harding 提交于
When Co-Developed-by tag was added, docs were only added to Documention/process/5.Posting.rst and were not added to Documention/process/submitting-patches.rst Add documentation to Documention/process/submitting-patches.rst Signed-off-by: NTobin C. Harding <me@tobin.cc> [jc: tweaked commas in the subheading] Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Matthew Wilcox 提交于
Sphinx 1.7 removed sphinx.util.compat.Directive so people who have upgraded cannot build the documentation. Switch to docutils.parsers.rst.Directive which has been available since docutils 0.5 released in 2009. Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694Co-developed-by: NTakashi Iwai <tiwai@suse.de> Acked-by: NJani Nikula <jani.nikula@intel.com> Cc: stable@vger.kernel.org Signed-off-by: NMatthew Wilcox <mawilcox@microsoft.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 23 2月, 2018 12 次提交
-
-
由 Aishwarya Pant 提交于
Right now, the description of the rapidio sysfs interfaces is in Documentation/rapidio/sysfs.txt. Since these are a part of the ABI, they should be in Documentation/ABI along with the rest. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Acked-by: NAlexandre Bounine <alexandre.bounine@idt.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Add documentation for sysfs interface of adp8860 series backlight devices by reading through code and git commits. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Acked-by: NMichael Hennerich <michael.hennerich@analog.com> Acked-by: NDaniel Thompson <daniel.thompson@linaro.org> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Add documentation for sysfs interface of adp5520/adp5501 analog devices backlight driver by reading code and looking through git commit logs. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Acked-by: NMichael Hennerich <michael.hennerich@analog.com> Acked-by: NDaniel Thompson <daniel.thompson@linaro.org> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Add documentation for sysfs interfaces of Texas Instruments lm3639 backlight + flash led driver chip by looking through git commits and reading code. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Acked-by: NDaniel Thompson <daniel.thompson@linaro.org> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Documentation has been compiled from git logs and by reading through code. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Add documentation for core and hardware specific infiniband interfaces. The descriptions have been collected from git commit logs, reading through code and data sheets. Some drivers have incomplete doc and are annotated with the comment '[to be documented]'. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Reviewed-by: NHal Rosenstock <hal@mellanox.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Documentation has been compiled from git commit logs and descriptions in Documentation/aoe/aoe.txt. This should be useful for scripting and tracking changes in the ABI. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Document sysfs attributes of s6e63m0 lcd panel driver by looking through git logs and reading code. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Aishwarya Pant 提交于
Clean up the sysfs documentation such that it is in the same format as described in Documentation/ABI/README. Mainly, the patch moves the attribute names to the 'What:' field. This might be useful for scripting and tracking changes in the ABI. Signed-off-by: NAishwarya Pant <aishpant@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mike Rapoport 提交于
Currently there is no automated checking for kernel-doc comments except running 'kernel-doc -v -none <filename>'. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide. Signed-off-by: NMike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Philipp Hahn 提交于
Move the _if_ outside the verbatim string. Make key ring name as a verbatim string. Signed-off-by: NPhilipp Hahn <hahn@univention.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Philipp Hahn 提交于
Commit d3bfe841 changed the name but did not update the documentation. Fixes: d3bfe841Signed-off-by: NPhilipp Hahn <hahn@univention.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 21 2月, 2018 2 次提交
-
-
由 Jonathan Corbet 提交于
So once upon a time I set out to fix the problem reported by Tobin wherein a literal block within a kerneldoc comment would be corrupted in processing. On the way, though, I got annoyed at the way I have to learn how kernel-doc works from the beginning every time I tear into it. As a result, seven of the following eight patches just get rid of some dead code and reorganize the rest - mostly turning the 500-line process_file() function into something a bit more rational. Sphinx output is unchanged after these are applied. Then, at the end, there's a tweak to stop messing with literal blocks. If anybody was unaware that I've not done any serious Perl since the 1990's, they will certainly understand that fact now.
-
由 Jonathan Corbet 提交于
Add the SPDX header while I'm in the neighborhood. The source itself just says "GNU General Public License", but it also refers people to the COPYING file for further information. Since COPYING says 2.0-only, that is what I have put into the header. Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 19 2月, 2018 9 次提交
-
-
由 Masanari Iida 提交于
This patch fixes a warning during "make xmldocs" Documentation/driver-api/slimbus.rst:93: WARNING: Title underline too short. Signed-off-by: NMasanari Iida <standby24x7@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Neuschäfer 提交于
Without this patch, the points 1-9 in the list are rendered as an HTML blockquote containing a list, causing them to be indented further than the rest of the list. While at it, also fix the quotation marks around G and P. Signed-off-by: NJonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
It helps to give some examples about how to use in-line comments also when nested union/structs are present. So add it. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
The parser at kernel-doc rejects names with dots in the middle. Fix it, in order to support nested structs/unions. Tested-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
We want to give some examples about how to do in-line comments for nested structs. So, move it to be after nested structs/unions chapter. The section content was not changed on this patch. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
Without ending with a ";", kernel-doc doesn't recognize it as an struct, and it fails to parse the example. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mauro Carvalho Chehab 提交于
There's a missing */ at the end of Kernel docs example. Even adding it, it will still produce 3 warnings: example:33: warning: Function parameter or member 'bar' not described in 'nested_foobar' example:33: warning: Function parameter or member 'bar.st1' not described in 'nested_foobar' example:33: warning: Function parameter or member 'bar.st2' not described in 'nested_foobar' So, make the example more complete and add the missing end of comment there. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Neuschäfer 提交于
The mailing list archives[1,2] show no activity since September 2011. [1]: https://lists.linuxfoundation.org/pipermail/bugme-new/ [2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/Signed-off-by: NJonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Mike Rapoport 提交于
When function description includes brackets after the function name as suggested by Documentation/doc-guide/kernel-doc, the kernel-doc script omits the function name from "Scanning doc for" report. Extending match for identifier name with optional brackets fixes this issue. Signed-off-by: NMike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 16 2月, 2018 4 次提交
-
-
由 Minghui Liu 提交于
Delete reference to the kernel-mentors mailing list because the mailing list no longer exists Signed-off-by: NMinghui Liu <minghui.liu.95@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Corbet 提交于
It can be useful to put code snippets into kerneldoc comments; that can be done with the "::" operator at the end of a line like this:: if (desperate) run_in_circles(); The ".. code-block::" directive can also be used to this end. kernel-doc currently fails to understand these literal blocks and applies its normal markup to them, which is then treated as literal by sphinx. The result is unsightly markup instead of a useful code snippet. Apply a hack to the output code to recognize literal blocks and avoid performing any special markup on them. It's ugly, but that means it fits in well with the rest of the script. Reviewed-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Corbet 提交于
Move STATE_INLINE and STATE_DOCBLOCK code out of process_file(), which now actually fits on a single screen. Delete an unused variable and add a couple of comments while I'm at it. Reviewed-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Corbet 提交于
Move the top-level prototype-processing code out of process_file(). Reviewed-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-