summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Input: alps - Update documentation for trackstick v3 formatPali Rohár2018-03-261-2/+5
| | | | | | | | Bits for M, R and L buttons are already processed in alps. Other newly documented bits not yet. Signed-off-by: Pali Rohár <pali.rohar@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: Mention why %p prints ptrvalJoel Stanley2018-03-231-2/+2
| | | | | | | | | | When debugging recent kernels, people will see '(ptrval)' but there isn't much information as to what that means. Briefly describe why it's there. Signed-off-by: Joel Stanley <joel@jms.id.au> Acked-by: Tobin C. Harding <me@tobin.cc> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* COPYING: use the new text with points to the license filesMauro Carvalho Chehab2018-03-232-366/+10Star
| | | | | | | | | | | | | Now that we have a new COPYING file with points to the Linux license files, replace it with the old content. This patch does: 1 file changed, 0 insertions(+), 0 deletions(-) rename COPYING.new => COPYING (100%) Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* COPYING: create a new file with points to the Kernel license filesMauro Carvalho Chehab2018-03-232-9/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the addition of SPDX patchset, the contents of COPYING file is now duplicated at two other files under LICENSE: LICENSES/preferred/GPL-2.0 LICENSES/exceptions/Linux-syscall-note It is easy to check that the contents of the licence written on those files are identical with COPYING using: $ diff -upr COPYING LICENSES/preferred/GPL-2.0 $ diff -upr COPYING LICENSES/exceptions/Linux-syscall-note|less Also, a new file was added, with describes how SPDX should work at the Kernel source files: Documentation/process/license-rules.rst Instead fo having it copying the contents of two files, and not even mentioning the third one, replace it by a file whose content points to the other tree files, preserving the Kernel's license. Adjust license-rules.rst accordingly. Please notice that this file preserves the Kernel license as is, without any changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Input: trackpoint: document sysfs interfaceAishwarya Pant2018-03-211-0/+115
| | | | | | | | Descriptions have been collected from git commit logs, code commits and the TrackPoint System Version 4.0 Engineering Specification. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* xfs: Change URL for the project in xfs.txtMasanari Iida2018-03-211-1/+1
| | | | | | | | | The oss.sgi.com doesn't exist any more. Change it to current project URL, https://xfs.wiki.kernel.org/ Signed-off-by: Masanari Iida <standby24x7@gmail.com> Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* char/bsr: add sysfs interface documentationAishwarya Pant2018-03-211-0/+25
| | | | | | | | Descriptions have collected from code comments and by reading through code. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* acpi: nfit: document sysfs interfaceAishwarya Pant2018-03-211-0/+233
| | | | | | | | | This is an attempt to document the nfit sysfs interface. The descriptions have been collected from git commit logs and the ACPI specification 6.2. Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* block: rbd: update sysfs interfaceAishwarya Pant2018-03-211-81/+122
| | | | | | | | | | | | | | The existing sysfs interface has been updated to be in the same format as described in Documentation/ABI/README. This will be useful for scripting and tracking changes in the ABI. Attributes have been grouped by functionality and/or the date on which they were added. There are a couple of more changes: - The attributes have been annotated with file permissions RO/RW/WO. - Added description of the bus attribute supported_features Signed-off-by: Aishwarya Pant <aishpant@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/sparse: fix typoEric Engestrom2018-03-211-1/+1
| | | | | Signed-off-by: Eric Engestrom <eric.engestrom@imgtec.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/CodingStyle: Add an example for bracesGary R Hook2018-03-211-0/+9
| | | | | | | | Add another example of required braces when using a compound statement in a loop. Signed-off-by: Gary R Hook <gary.hook@amd.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/vm: update 00-INDEXMike Rapoport2018-03-211-0/+18
| | | | | | | | Several files were added to Documentation/vm without updates to 00-INDEX. Fill in the missing documents Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-doc: Remove __sched markingsMatthew Wilcox2018-03-211-0/+1
| | | | | | | | I find the __sched annotations unaesthetic in the kernel-doc. Remove them like we remove __inline, __weak, __init and so on. Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs: Added a pointer to the formatted docs to READMEJonathan Corbet2018-03-211-1/+3
| | | | | | | Kernel.org nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* README: Improve documentation descriptionsMartin Kepplinger2018-03-211-4/+3Star
| | | | | | | | | | | | "This file" indeed was moved once, but at some point "this file", the top-level README, becomes a file in itself. Now that time has come :) Let's describe how things are, and suggest reading "this file" first, "this file" simply being a the admin-guide README file, not a file that was once moved. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: clarify security-bugs disclosure policyDave Hansen2018-03-091-11/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I think we need to soften the language a bit. It might scare folks off, especially the: We prefer to fully disclose the bug as soon as possible. which is not really the case. Linus says: It's not full disclosure, it's not coordinated disclosure, and it's not "no disclosure". It's more like just "timely open fixes". I changed a bit of the wording in here, but mostly to remove the word "disclosure" since it seems to mean very specific things to people that we do not mean here. Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com> Reviewed-by: Dan Williams <dan.j.williams@intel.com> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Acked-by: Kees Cook <keescook@chromium.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Linus Torvalds <torvalds@linux-foundation.org> Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk> Cc: Andrea Arcangeli <aarcange@redhat.com> Cc: Andy Lutomirski <luto@kernel.org> Cc: Tim Chen <tim.c.chen@linux.intel.com> Cc: Alexander Viro <viro@zeniv.linux.org.uk> Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Mark Rutland <mark.rutland@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: ftrace: fix a few formatting issuesJonathan Corbet2018-03-072-9/+9
| | | | | | | Make sure that literal * characters are not interpreted as emphasis markers. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* trace doc: convert trace/stm.txt to rst formatChangbin Du2018-03-072-11/+13
| | | | | | | | | 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/intel_th.txt to rst formatChangbin Du2018-03-072-21/+23
| | | | | | | | | 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/hwlat_detector.txt to rst fromatChangbin Du2018-03-072-11/+16
| | | | | | | | | 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/mmiotrace.txt to rst formatChangbin Du2018-03-072-33/+54
| | | | | | | | | 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-msr.txt to rst formatChangbin Du2018-03-073-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/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/+1Star
| | | | | | | | | | | | | | 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.
generated by cgit v1.2.3-55-g7522 (git 2.39.0) at 2024-07-07 02:13:46 +0200