WIth ReST style documentation, we moved it to driver-api/dmaengine
so update this in MAINTAINERS entry
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This converts and moves pxa_dma file with some format
changes for RST style
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This converts and moves dmatest file with some format
changes for RST style
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This converts and moves client API file with some format
changes for RST style
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This moves and converts provider file with some format changes
for RST style
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This removes the index file and adds the index.rst as placeholder
and update driver-api index to add dmaengine. As a consequence
dmaengine documentation will be in driver-api/
Signed-off-by: NVinod Koul <vinod.koul@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

With the coming removal of jprobes, using ftrace callbacks is one of the
utilities that replace the jprobes functionality. Having a document that
explains how to use ftrace as such will help in the transition from jprobes
to ftrace. This document is for kernel developers that require attaching a
callback to a function within the kernel.

Link: http://lkml.kernel.org/r/150724519527.5014.10207042218696587159.stgit@devboxSigned-off-by: NSteven Rostedt (VMware) <rostedt@goodmis.org>
[jc: fixed one formatting issue that broke the docs build]
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

- Use the same file name in the explanation and in the example (conex.c vs
sonixj.c)
- Add a missing ':' in a :ref: tag which leads to incorrect Shpinx output
- Add some missing ',' and ';'
Signed-off-by: NChristophe JAILLET <christophe.jaillet@wanadoo.fr>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add a script that finds files with kernel-doc comments for imported functions
that are not included anywhere in documentation.
Signed-off-by: Nsayli karnik <karniksayli1995@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

In preparation for unconditionally passing the struct timer_list pointer to
all timer callbacks, switch to using the new timer_setup() and from_timer()
to pass the timer pointer explicitly.
Signed-off-by: NKees Cook <keescook@chromium.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

There are some good comments about bitmap operations in lib/bitmap.c
and include/linux/bitmap.h, so format them for document generation and
pull them into core-api/kernel-api.rst.

I converted the "tables" of functions from using tabs to using spaces
so that they are more readable in the source file and in the generated
output.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make refs to selftests files valid including:
  - watchdog-test.c
  - dnotify_test.c
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Acked-by: NRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

There is no Coccinelle version 1.2.  1.0.2 must be what was intended.
Signed-off-by: NJulia Lawall <Julia.Lawall@lip6.fr>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

CONFIG_BLK_DEV_HD_IDE was removed in commit 80aa31cb ("ide:
remove CONFIG_BLK_DEV_HD_IDE config option (take 2)") but the ide-cd
documentation was not updated and still asks users to disable it,
which is misleading and involves a fruitless search.
Signed-off-by: NFinn Thain <fthain@telegraphics.com.au>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Tom Saeger says:

Recently, while reading up on binfmt I attempted to open a document ref
only to find it was invalid.  I did a quick grep, found all the
binfmt_misc related broken refs and sent a patch.

Fine. Easy.

Then I wondered, "how many broken doc refs are there?".

Turns out with all the recent doc moves, quite a few.

I went about fixing just those found in Documentation/,
except those in Documentation/translations/ and
Documentation/devicetree/ for now.

Most of these changes were s/txt/rst/ or fixing up a path to an obvious
new location.  Some required going back to v4.10 v4.4 or some other
version to sleuth-out what content was actually being referenced and
then fixing the reference to point to the new file with that content.

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Update ref to usb proc_usb_info.txt.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make sound doc refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Reviewed-by: NTakashi Iwai <tiwai@suse.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make media doc refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make security document refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make `input` document refs valid including:
  - joystick
  - joystick-parport
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Reviewed-by: NTakashi Iwai <tiwai@suse.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make admin-guide document refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Acked-by: NRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make driver-api document refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Acked-by: NRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add a simple script and build target to do a treewide grep for
references to files under Documentation, and report the non-existing
file in stderr. It tries to take into account punctuation not part of
the filename, and wildcards, but there are bound to be false positives
too. Mostly seems accurate though.

We've moved files around enough to make having this worthwhile.
Signed-off-by: NJani Nikula <jani.nikula@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Change to enable dochelp run from main make level to make it easier to
use it.
Signed-off-by: NShuah Khan <shuahkh@osg.samsung.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Enhance documentation help message to specify the default location for
the generated documents.
Signed-off-by: NShuah Khan <shuahkh@osg.samsung.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Update to include details on make O=dir support and other changes improve
test results output.
Signed-off-by: NShuah Khan <shuahkh@osg.samsung.com>
[jc: Tweaked RST formatting slightly ]
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Commit 7aa7a036 (PM: docs: Delete the obsolete states.txt
document) forgot to update kernel-parameters.txt with a reference
to the new sleep-states.rst document and it still points to
states.txt that was dropped, so fix it now.

Fixes: 7aa7a036 (PM: docs: Delete the obsolete states.txt document)
Signed-off-by: NRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add a kernel-api section on Math Functions.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add kernel-doc notation for the gcd() function (so that it can be
added to the kernel-api documentation).
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add missing kernel-doc notation (function parameters) for several
div() functions.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add missing kernel-doc notation for 2 div() functions.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Fix <linux/log2.h> kernel-doc:
- Add kernel-doc notation to some functions.
- Fix kernel-doc notation in function parameters.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Way back in 2008 we didn't have "robust" in-kernel documentation system,
so the idea of putting something like the kernel driver statement in the
kernel tree wasn't even imagined.  But now that has changed, so add the
old document to the kernel source itself to allow for us to properly
reference it in one canonical place (as the LF wiki keeps moving things
around.)

This also will allow people to add their names to it, as I seem to have
lost the ability to do that by not knowing how to edit things on the
original document.
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: NMauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>