aboutsummaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2018-03-29Documentation/process: update FUSE project websiteMartin Kepplinger1-1/+1
According to the old project site, https://sourceforge.net/projects/fuse/ the project has moved to https://github.com/libfuse/ so we update the link to point to the latest libfuse release. Signed-off-by: Martin Kepplinger <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-29docs: kernel-doc: fix parsing of arraysMauro Carvalho Chehab1-1/+1
The logic with parses array has a bug that prevents it to parse arrays like: struct { ... struct { u64 msdu[IEEE80211_NUM_TIDS + 1]; ... ... Fix the parser to accept it. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26dmaengine: Fix spelling for parenthesis in dmatest documentationAndy Shevchenko1-4/+5
Fix spelling for parenthesis in dmatest documentation. Signed-off-by: Andy Shevchenko <[email protected]> [ jc: did s/parenthesis/parentheses/ and reflowed ] Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26dmaengine: Make dmatest.rst indeed reST compatibleAndy Shevchenko1-14/+12
Make dmatest.rst indeed reST compatible. Achieve this by fixing several formatting issues. Signed-off-by: Andy Shevchenko <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26dmaengine: Add note to dmatest documentation about supported channelsAndy Shevchenko1-0/+5
The documentation is not so clear for newbies in a sense of what type of the channels are supported by it. Clarify this by adding a note at the preamble of the documentation. Reported-by: "Zhu, Tony" <[email protected]> Signed-off-by: Andy Shevchenko <[email protected]> Acked-By: Vinod Koul <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26Documentation: magic-numbers: Fix typoMartin Kepplinger1-1/+1
This fixes a little then / them confusion. Signed-off-by: Martin Kepplinger <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26Documentation: admin-guide: add kvmconfig, xenconfig and tinyconfig commandsMartin Kepplinger1-0/+7
Add kvmconfig, xenconfig and tinyconfig to the list of alternative configuration commands. Descriptions are directly taken from the Makefile. Signed-off-by: Martin Kepplinger <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-26Input: alps - Update documentation for trackstick v3 formatPali Rohár1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-23Documentation: Mention why %p prints ptrvalJoel Stanley1-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 <[email protected]> Acked-by: Tobin C. Harding <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-23COPYING: use the new text with points to the license filesMauro Carvalho Chehab2-366/+10
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 <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-23COPYING: create a new file with points to the Kernel license filesMauro Carvalho Chehab2-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 <[email protected]> Reviewed-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21Input: trackpoint: document sysfs interfaceAishwarya Pant1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21xfs: Change URL for the project in xfs.txtMasanari Iida1-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 <[email protected]> Reviewed-by: Darrick J. Wong <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21char/bsr: add sysfs interface documentationAishwarya Pant1-0/+25
Descriptions have collected from code comments and by reading through code. Signed-off-by: Aishwarya Pant <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21acpi: nfit: document sysfs interfaceAishwarya Pant1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21block: rbd: update sysfs interfaceAishwarya Pant1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21Documentation/sparse: fix typoEric Engestrom1-1/+1
Signed-off-by: Eric Engestrom <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21Documentation/CodingStyle: Add an example for bracesGary R Hook1-0/+9
Add another example of required braces when using a compound statement in a loop. Signed-off-by: Gary R Hook <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21docs/vm: update 00-INDEXMike Rapoport1-0/+18
Several files were added to Documentation/vm without updates to 00-INDEX. Fill in the missing documents Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21kernel-doc: Remove __sched markingsMatthew Wilcox1-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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21Docs: Added a pointer to the formatted docs to READMEJonathan Corbet1-1/+3
Kernel.org nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21README: Improve documentation descriptionsMartin Kepplinger1-4/+3
"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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-09docs: clarify security-bugs disclosure policyDave Hansen1-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 <[email protected]> Reviewed-by: Dan Williams <[email protected]> Reviewed-by: Greg Kroah-Hartman <[email protected]> Acked-by: Kees Cook <[email protected]> Cc: Thomas Gleixner <[email protected]> Cc: Linus Torvalds <[email protected]> Cc: Alan Cox <[email protected]> Cc: Andrea Arcangeli <[email protected]> Cc: Andy Lutomirski <[email protected]> Cc: Tim Chen <[email protected]> Cc: Alexander Viro <[email protected]> Cc: Andrew Morton <[email protected]> Cc: Mark Rutland <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07docs: ftrace: fix a few formatting issuesJonathan Corbet2-9/+9
Make sure that literal * characters are not interpreted as emphasis markers. Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/stm.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/intel_th.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/hwlat_detector.txt to rst fromatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/mmiotrace.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/events-msr.txt to rst formatChangbin Du3-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/events-nmi.txt to rst formatChangbin Du3-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/events-power.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/events-kmem.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/events.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/tracepoints.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/uprobetracer.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/kprobetrace.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/ftrace.txt to rst formatChangbin Du3-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/tracepoint-analysis.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: add ftrace-uses.rst to doc treeChangbin Du2-11/+13
Add ftrace-uses.rst into Sphinx TOC tree. Few format issues are fixed. Cc: Steven Rostedt <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07trace doc: convert trace/ftrace-design.txt to rst formatChangbin Du2-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 <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07Documentation: add Linux tracing to Sphinx TOC treeChangbin Du2-0/+7
This just add a index.rst for trace subsystem. More docs will be added later. Cc: Steven Rostedt <[email protected]> Signed-off-by: Changbin Du <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07documentation: add my name to kernel driver statementAaro Koskinen1-0/+1
Add my name to kernel driver statement. Signed-off-by: Aaro Koskinen <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07docs: add Co-Developed-by docsTobin C. Harding1-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 <[email protected]> [jc: tweaked commas in the subheading] Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-07Documentation/sphinx: Fix Directive import errorMatthew Wilcox1-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 <[email protected]> Acked-by: Jani Nikula <[email protected]> Cc: [email protected] Signed-off-by: Matthew Wilcox <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23Documentation: rapidio: move sysfs interface to ABIAishwarya Pant3-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 <[email protected]> Acked-by: Alexandre Bounine <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23backlight: adp8860: document sysfs attributesAishwarya Pant1-0/+54
Add documentation for sysfs interface of adp8860 series backlight devices by reading through code and git commits. Signed-off-by: Aishwarya Pant <[email protected]> Acked-by: Michael Hennerich <[email protected]> Acked-by: Daniel Thompson <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23backlight: adp5520: document sysfs attributesAishwarya Pant1-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 <[email protected]> Acked-by: Michael Hennerich <[email protected]> Acked-by: Daniel Thompson <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23backlight: lm3639: document sysfs attributesAishwarya Pant1-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 <[email protected]> Acked-by: Daniel Thompson <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23block/loop: add documentation for sysfs interfaceAishwarya Pant1-0/+50
Documentation has been compiled from git logs and by reading through code. Signed-off-by: Aishwarya Pant <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-02-23Documentation/ABI: update infiniband sysfs interfacesAishwarya Pant3-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 <[email protected]> Reviewed-by: Hal Rosenstock <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>