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: NAishwarya Pant <aishpant@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

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: NAishwarya Pant <aishpant@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NEric Engestrom <eric.engestrom@imgtec.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add another example of required braces when using a compound statement in
a loop.
Signed-off-by: NGary R Hook <gary.hook@amd.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Several files were added to Documentation/vm without updates to 00-INDEX.
Fill in the missing documents
Signed-off-by: NMike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

I find the __sched annotations unaesthetic in the kernel-doc.  Remove
them like we remove __inline, __weak, __init and so on.
Signed-off-by: NMatthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Kernel.org nicely maintains an online copy of the formatted documentation;
tell our users that it exists.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

"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: NMartin Kepplinger <martink@posteo.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

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: NDave Hansen <dave.hansen@linux.intel.com>
Reviewed-by: NDan Williams <dan.j.williams@intel.com>
Reviewed-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: NKees 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: NJonathan Corbet <corbet@lwn.net>

Make sure that literal * characters are not interpreted as emphasis
markers.
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>