| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
The format of the structure references in device_link.rst is
incorrect, because it doesn't cause proper references to the
struct data types to be generated (for struct dev_pm_domain in
particular).
Fix that by using the :c:type:`struct name <name>` convention
for encoding references to struct data types.
Fixes: aad800403a87 (Documentation/core-api/device_link: Add initial documentation)
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
There is a better way to represent structure references than it was
done in device.rst by commit 730c4c053012 (PM / sleep / docs: Convert
PM notifiers document to reST), which is to use "struct name" as a
link caption (e.g. :c:type:`struct device <device>`). That will
cause sphinx to generate a proper reference to the data type in
question (struct device in the example above) and "struct name"
will work as the link in the HTML output.
Fix device.rst by using that convention where applicable.
Fixes: 730c4c053012 (PM / sleep / docs: Convert PM notifiers document to reST)
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
| |
Move the document describing PM notifiers (used during system sleep
state transitions) to Documentation/driver-api/pm/, convert it to reST
and update it to use current terminology. Also replace the remaining
references to the old version of it in .txt documents with references
to the new one.
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
Move the document describing the system sleep state transitions API
for devices to Documentation/driver-api/pm/, convert it to reST and
update it to use current terminology. Also remove the remaining
reference to the old version of it from pm.h.
The new document still contains references to some documents in the
.txt format that will be converted later.
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
| |
A fairly straightforward conversion to RST; the document is then added to
the driver-api manual.
Of course, this document has seen no substantive changes since 2008, so
chances are it needs work in other areas as well.
Cc: Mark Brown <broonie@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Convert deviceiobook.tmpl to RST and incorporate it into the driver API
manual.
Like the rest of our documentation, this one could use some work. There's
no mention of ioremap() and friends, no mention of io_read*() and friends.
But we have nice documentation for all those folks writing new drivers that
do port I/O :).
The :c:func: notation has been left off of all the read*/write* functions.
There's no kerneldoc comments for them anyway, so those links will never be
live, and writing a bunch of repetitive "read a byte from I/O memory"
comments lacks appeal.
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
| |
This is a manual conversion of the existing DocBook documentation
for IIO. The intent is not to substantially change any of the
content in this patch, but to give a base to build upon.
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
| |
Instead of storing the concepts dictionary inside header file,
move it to the subsystem documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
|
| |
|
|
|
|
|
|
|
|
| |
Currently, there's no device driver documentation for the EDAC
subsystem at the driver-api book. Fill in the blanks for the
structures and functions that misses documentation, uniform
the word on the existing ones, and add a new edac.rst file at
driver-api, in order to document the EDAC subsystem.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Just prep work to polish and consolidate all the dma-buf related
documenation.
Unfortunately I didn't discover a way to both integrate this new file
into the overall toc while keeping it at the current place. Work
around that by moving it into the overall driver-api/index.rst.
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Sumit Semwal <sumit.semwal@linaro.org>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Document device links as introduced in v4.10 with commits:
4bdb35506b89 ("driver core: Add a wrapper around
__device_release_driver()")
9ed9895370ae ("driver core: Functional dependencies tracking
support")
8c73b4288496 ("PM / sleep: Make async suspend/resume of devices use
device links")
21d5c57b3726 ("PM / runtime: Use device links")
baa8809f6097 ("PM / runtime: Optimize the use of device links")
Signed-off-by: Lukas Wunner <lukas@wunner.de>
[ jc: Moved from core-api to driver-api ]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
| |
Put this documentation with the other driver docs and try to keep the top
level reasonably clean.
Cc: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
| |
This is a conversion of the USB documentation to the Sphinx format.
No content was altered or reformatted.
Signed-off-by: Oliver <oneukum@suse.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
| |
Few files under dma-buf/ changed their names but the changes didn't
applied to a document that referencing them. It is causing few
documentation build warnings. This commit fixes the problems by
applying changed file names on the document.
Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
|
| |
Add minimal conf.py makes the driver-api folder buildable
stand-alone. To build only this folder run::
make SPHINXDIRS=driver-api htmldocs
make SPHINXDIRS=driver-api pdfdocs
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
| |
Perform a relatively simple conversion of vme_api.txt to reStructuredText
and move under driver-api, which seems the most logical place for this
documentation.
Signed-off-by: Martyn Welch <martyn.welch@collabora.co.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
| |
This is the driver API document, so the internal stuff is just noise here.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
|
| |
It never made sense to keep these documents together; move each into its
own file.
Drop the section numbering on hsi.txt on its way to its own file.
Suggested-by: Sebastian Reichel <sre@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
|
| |
The HSI subsystem documentation was split across hsi.txt and the
device-drivers docbook. Now that the latter has been converted to Sphinx,
pull in the HSI document so that it's all in one place.
Acked-by: Sebastian Reichel <sre@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
| |
|
|
|
|
|
|
| |
We don't need to keep it as a single large file anymore; split it up so
that it is easier to manage and the individual sections can be read
directly as plain files.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
|
|
Perform a basic sphinx conversion of the device-drivers docbook and move it
to its own directory.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
|
