summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* trace doc: convert trace/events-nmi.txt to rst formatChangbin Du2018-03-073-43/+46
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/events-power.txt to rst formatChangbin Du2018-03-072-22/+31
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/events-kmem.txt to rst formatChangbin Du2018-03-072-19/+32
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/events.txt to rst formatChangbin Du2018-03-072-333/+337
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/tracepoints.txt to rst formatChangbin Du2018-03-072-37/+41
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/uprobetracer.txt to rst formatChangbin Du2018-03-072-18/+27
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/kprobetrace.txt to rst formatChangbin Du2018-03-072-46/+55
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/ftrace.txt to rst formatChangbin Du2018-03-073-3220/+3333
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/tracepoint-analysis.txt to rst formatChangbin Du2018-03-072-15/+27
| | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: add ftrace-uses.rst to doc treeChangbin Du2018-03-072-11/+13
| | | | | | | | Add ftrace-uses.rst into Sphinx TOC tree. Few format issues are fixed. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/ftrace-design.txt to rst formatChangbin Du2018-03-072-113/+141
| | | | | | | | | | 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: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: add Linux tracing to Sphinx TOC treeChangbin Du2018-03-072-0/+7
| | | | | | | | | This just add a index.rst for trace subsystem. More docs will be added later. Cc: Steven Rostedt <rostedt@goodmis.org> Signed-off-by: Changbin Du <changbin.du@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* documentation: add my name to kernel driver statementAaro Koskinen2018-03-071-0/+1
| | | | | | | | Add my name to kernel driver statement. Signed-off-by: Aaro Koskinen <aaro.koskinen@iki.fi> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: add Co-Developed-by docsTobin C. Harding2018-03-071-2/+7
| | | | | | | | | | | | 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: Tobin C. Harding <me@tobin.cc> [jc: tweaked commas in the subheading] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/sphinx: Fix Directive import errorMatthew Wilcox2018-03-071-2/+1
| | | | | | | | | | | | | | 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=1083694 Co-developed-by: Takashi Iwai <tiwai@suse.de> Acked-by: Jani Nikula <jani.nikula@intel.com> Cc: stable@vger.kernel.org Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: rapidio: move sysfs interface to ABIAishwarya Pant2018-02-233-158/+256
| | | | | | | | | | 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: Aishwarya Pant <aishpant@gmail.com> Acked-by: Alexandre Bounine <alexandre.bounine@idt.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* backlight: adp8860: document sysfs attributesAishwarya Pant2018-02-231-0/+54
| | | | | | | | | | Add documentation for sysfs interface of adp8860 series backlight devices by reading through code and git commits. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Acked-by: Michael Hennerich <michael.hennerich@analog.com> Acked-by: Daniel Thompson <daniel.thompson@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* backlight: adp5520: document sysfs attributesAishwarya Pant2018-02-231-0/+31
| | | | | | | | | | Add documentation for sysfs interface of adp5520/adp5501 analog devices backlight driver by reading code and looking through git commit logs. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Acked-by: Michael Hennerich <michael.hennerich@analog.com> Acked-by: Daniel Thompson <daniel.thompson@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* backlight: lm3639: document sysfs attributesAishwarya Pant2018-02-231-0/+11
| | | | | | | | | | 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: Aishwarya Pant <aishpant@gmail.com> Acked-by: Daniel Thompson <daniel.thompson@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* block/loop: add documentation for sysfs interfaceAishwarya Pant2018-02-231-0/+50
| | | | | | | | Documentation has been compiled from git logs and by reading through code. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/ABI: update infiniband sysfs interfacesAishwarya Pant2018-02-233-143/+820
| | | | | | | | | | | 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: Aishwarya Pant <aishpant@gmail.com> Reviewed-by: Hal Rosenstock <hal@mellanox.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* aoe: document sysfs interfaceAishwarya Pant2018-02-231-0/+45
| | | | | | | | | 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: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/ABI: add sysfs interface for s6e63m0 lcd driverAishwarya Pant2018-02-231-0/+27
| | | | | | | | Document sysfs attributes of s6e63m0 lcd panel driver by looking through git logs and reading code. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/ABI: clean up sysfs-class-pktcdvdAishwarya Pant2018-02-231-54/+75
| | | | | | | | | | 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: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc-guide: kernel-doc: add comment about formatting verificationMike Rapoport2018-02-231-0/+11
| | | | | | | | | 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: Mike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: module-signing.rst: Fix reST formattingPhilipp Hahn2018-02-231-2/+2
| | | | | | | | | Move the _if_ outside the verbatim string. Make key ring name as a verbatim string. Signed-off-by: Philipp Hahn <hahn@univention.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: Rename .system_keyring to .builtin_trusted_keysPhilipp Hahn2018-02-231-5/+5
| | | | | | | | | Commit d3bfe84129f65e0af2450743ebdab33d161d01c9 changed the name but did not update the documentation. Fixes: d3bfe84129f65e0af2450743ebdab33d161d01c9 Signed-off-by: Philipp Hahn <hahn@univention.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'kerneldoc2' into docs-nextJonathan Corbet2018-02-201-301/+365
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * docs: Add an SPDX header to kernel-docJonathan Corbet2018-02-201-0/+1
| | | | | | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Don't mangle literal code blocks in commentsJonathan Corbet2018-02-151-5/+64
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Finish moving STATE_* code out of process_file()Jonathan Corbet2018-02-151-62/+77
| | | | | | | | | | | | | | | | | | 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: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Move STATE_PROTO processing into its own functionJonathan Corbet2018-02-151-18/+28
| | | | | | | | | | | | | | Move the top-level prototype-processing code out of process_file(). Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Move STATE_BODY processing to a separate functionJonathan Corbet2018-02-151-92/+101
| | | | | | | | | | | | | | Also group the pseudo-global $leading_space variable with its peers. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Move STATE_NAME processing into its own functionJonathan Corbet2018-02-151-65/+72
| | | | | | | | | | | | | | | | Move this code out of process_file() in the name of readability and maintainability. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Move STATE_NORMAL processing into its own functionJonathan Corbet2018-02-151-5/+16
| | | | | | | | | | | | | | | | Begin the process of splitting up the nearly 500-line process_file() function by moving STATE_NORMAL processing to a separate function. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Rename and split STATE_FIELDJonathan Corbet2018-02-151-11/+11
| | | | | | | | | | | | | | | | | | | | | | | | STATE_FIELD describes a parser state that can handle any part of a kerneldoc comment body; rename it to STATE_BODY to reflect that. The $in_purpose variable was a hidden substate of STATE_FIELD; get rid of it and make a proper state (STATE_BODY_MAYBE) instead. This will make the subsequent process_file() splitup easier. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: kernel-doc: Get rid of xml_escape() and friendsJonathan Corbet2018-02-151-56/+9
| | | | | | | | | | | | | | | | | | XML escaping is a worry that came with DocBook, which we no longer have any dealings with. So get rid of the useless xml_escape()/xml_unescape() functions. No change to the generated output. Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | linux-next: SLIMbus: doc: Fix a warning "Title underline too short"Masanari Iida2018-02-191-1/+1
| | | | | | | | | | | | | | | | | | | | This patch fixes a warning during "make xmldocs" Documentation/driver-api/slimbus.rst:93: WARNING: Title underline too short. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | admin-guide: Fix list formatting in tained-kernels.htmlJonathan Neuschäfer2018-02-181-9/+9
| | | | | | | | | | | | | | | | | | | | | | 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: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-guide: kernel-doc: add examples about nested union/structsMauro Carvalho Chehab2018-02-181-2/+11
| | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | scripts: kernel-doc: support in-line comments on nested structs/unionsMauro Carvalho Chehab2018-02-181-1/+1
| | | | | | | | | | | | | | | | | | The parser at kernel-doc rejects names with dots in the middle. Fix it, in order to support nested structs/unions. Tested-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-guide: kernel-doc: move in-line section to be after nested structMauro Carvalho Chehab2018-02-181-28/+28
| | | | | | | | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-guide: kernel-doc: fix example for inlined commentsMauro Carvalho Chehab2018-02-181-1/+1
| | | | | | | | | | | | | | | | Without ending with a ";", kernel-doc doesn't recognize it as an struct, and it fails to parse the example. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc-guide: kernel-doc: fix example for nested_foobar structMauro Carvalho Chehab2018-02-181-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation/process/howto: Remove outdated info about bugzilla mailing listsJonathan Neuschäfer2018-02-181-8/+0
| | | | | | | | | | | | | | | | | | | | 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: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | scripts: kernel_doc: fixup reporting of function identifiersMike Rapoport2018-02-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | 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: Mike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation: Delete reference to the kernel-mentors mailing listMinghui Liu2018-02-161-7/+0
| | | | | | | | | | | | | | Delete reference to the kernel-mentors mailing list because the mailing list no longer exists Signed-off-by: Minghui Liu <minghui.liu.95@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Restructure kernel-doc.rstMatthew Wilcox2018-02-131-259/+217
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I found the layout confusing with multiple introductions to what kernel-doc is and how to use it. I made the following changes: - Moved the 'Including kernel-doc comments' section to the end of the document -- we should explain what it *is* before we explain how to integrate it. - Moved the 'Recommendations' subsection to the top. We want people to know what to document before telling them how to do it. - Rewrite the 'Writing kernel-doc comments' section, integrating the 'Recommendations' subsection and a paragraph from 'How to format kernel-doc comments'. - Remove the paragraph about the kernel-doc script; we're supposed to be teaching people how to use punctuation to write pretty documentation, not documenting the build tooling. - Split the 'Parameters and member arguments' section into 'Function parameters' and 'Members'. Structure members are not commonly referred to as arguments. - Integrate the 'private:' and 'public:' tag descriptions into the 'Members' section. - Move the 'In-line member documentation comments' subsection up to be with the 'Members' section. Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Fix whitespace in exampleMatthew Wilcox2018-02-131-1/+1
| | | | | | | | | | | | | | | | Line up the second line in the way that the example purports to be showing. Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Add scripts/split-man.plMatthew Wilcox2018-02-132-28/+30
| | | | | | | | | | | | | | | | | | Instead of asking the user to copy and paste a small perl script from the documentation, just distribute the perl script in the scripts directory. Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-04 06:53:50 +0000