summaryrefslogtreecommitdiffstats
path: root/Documentation (follow)
Commit message (Collapse)AuthorAgeFilesLines
* docs: 00-INDEX: remove non-existing entriesMauro Carvalho Chehab2016-12-051-52/+0
| | | | | | | | Several entries were moved to a directory; others got simply removed. Get rid of those entries. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: 00-INDEX: add missing entries for documentation files/dirsMauro Carvalho Chehab2016-12-051-4/+60
| | | | | | | | | Several directories and individual files don't have entries at 00-INDEX. Add them, using, as reference, the initial text inside the documentation file(s). Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: 00-INDEX: consolidate process/ and admin-guide/ descriptionMauro Carvalho Chehab2016-12-051-57/+4
| | | | | | | | | | Instead of having descriptions for individual files inside the process/ and admin-guide/ documentation, consolidate them into one entry per directory, just like other descriptions inside 00-INDEX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs: change sh -> awk in REPORTING-BUGSKevin Peng2016-12-051-1/+1
| | | | | | | | scripts/ver_linux has been rewritten as an awk script; update documentation to reflect this fact. Signed-off-by: Kevin Peng <kkpengboy@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/core-api/device_link: Add initial documentationLukas Wunner2016-12-052-0/+280
| | | | | | | | | | | | | | | | 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>
* core-api: remove an unexpected unidentMauro Carvalho Chehab2016-12-011-1/+1
| | | | | | | | As complained by Sphinx: Documentation/core-api/assoc_array.rst:13: WARNING: Enumerated list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* ppc/idle: Add documentation for powersave=offBalbir Singh2016-12-011-0/+6
| | | | | | | | Update kernel-parameters.txt to add Documentation for powersave=off. Signed-off-by: Balbir Singh <bsingharora@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Doc: Correct typo, "Introdution" => "Introduction"Sanjeev2016-12-014-8/+8
| | | | | | | | This corrects a set of spelling mistakes, probably from an automated conversion. Signed-off-by: Sanjeev Gupta <ghane0@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'silvio' into docs-nextJonathan Corbet2016-12-017-918/+934
|\
| * Documentation/atomic_ops.txt: convert to ReST markupSilvio Fricke2016-12-013-153/+175
| | | | | | | | | | | | | | ... and move to core-api folder. Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/local_ops.txt: convert to ReST markupSilvio Fricke2016-12-013-191/+207
| | | | | | | | | | | | | | | | ... and move to core-api folder. Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/assoc_array.txt: convert to ReST markupSilvio Fricke2016-12-013-574/+552
| | | | | | | | | | | | | | | | ... and move to Documentation/core-api folder. Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: parse-headers.pl: cleanup the documentationMauro Carvalho Chehab2016-12-012-126/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Keeping both rst and in-file documentation in sync can be harsh. So, simplify the script's internal documntation to a bare minimum, and add a mention to the ReST file with its full documentation. This way, a quick help is still available at the command line, while the complete one is maintained at the ReST format. As we won't be using pad2rst anymore, do a cleanup at the ReST file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: fix media cleandocs targetMauro Carvalho Chehab2016-12-012-2/+2
| | | | | | | | | | | | | | The builddir prefix was missing on make cleandocs. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: media/Makefile: reorganize the rulesMauro Carvalho Chehab2016-12-011-21/+24
| | | | | | | | | | | | | | | | | | Better organize the media/Makefile, in order to better split what's related to image conversion from the ones related to parse-headers.pl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: media: build SVG from graphviz filesMauro Carvalho Chehab2016-12-013-74/+16
| | | | | | | | | | | | | | | | Instead of keeping both SVG and graphviz files, dynamically build SVG from its graphviz sources. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: replace bayer.png by a SVG imageMauro Carvalho Chehab2016-12-014-2/+987
| | | | | | | | | | | | | | | | SVG images are scalable, with makes easier to output on different formats. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: replace the selection.png by a SVG imageMauro Carvalho Chehab2016-12-014-2/+5815
| | | | | | | | | | | | | | | | | | | | bitmap images don't scale too well. So, replace it by a SVG image, written in inkscape. I'm using the 2009's temporary logo.svg image from 8032b526d1a3 ("linux.conf.au 2009: Tuz"), with a Tasmanian Devil wearing a tux mask. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: convert pipeline to SVG formatMauro Carvalho Chehab2016-12-015-2/+83
| | | | | | | | | | | | | | | | | | | | | | The pipeline image was produced from some dot file that has long missed. Create a pipeline.dot with the graph and convert it to SVG. As we're planning to add future support for graphviz graphics, also store the .dot file on the tree, as this will make easier when we add such Sphinx extension. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs-rst: nv12mt zigzag images: replace by SVG imagesMauro Carvalho Chehab2016-12-016-4/+2045
| | | | | | | | | | | | | | | | Instead of using bitmap images to show the zigzag macroblock parsing, replace it by a SVG ones, with is scalable. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | svg files: cleanup themMauro Carvalho Chehab2016-12-019-4759/+6712
| | | | | | | | | | | | | | | | | | | | Use sans-serif font on all documents, split text lines, ungroup elements, and do other misc cleanups, in order to make all of them to look better, and to have smaller columns inside their lines. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | convert more media images to SVGMauro Carvalho Chehab2016-12-0116-12/+6849
| | | | | | | | | | | | | | | | | | Using vectorial graphics provide a better visual. As those images are originally using a vectorial graphics input at the pdf files, use them, from an old media tree repository, converting them to SVG. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc: Sphinxify the tracepoint docbookJonathan Corbet2016-11-294-115/+58
| | | | | | | | | | | | | | | | | | | | Convert the tracepoint docbook template to RST and add it to the core-api manual. No changes to the actual text beyond the mechanical formatting conversion. Cc: Jason Baron <jbaron@redhat.com> Cc: William Cohen <wcohen@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc: debugobjects: actually pull in the kerneldoc commentsJonathan Corbet2016-11-291-19/+15
| | | | | | | | | | | | | | | | | | | | | | Add the appropriate markup to get the kerneldoc comments out of lib/debugobjects.c that have never seen the light of day until now. A logical next step, left for the reader at the moment, is to move the function descriptions *out* of debug-objects.rst and into the kerneldoc comments themselves. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc: Convert the debugobjects DocBook template to sphinxJonathan Corbet2016-11-294-446/+329
| | | | | | | | | | | | | | | | | | | | | | | | A couple of the most minor heading tweaks, otherwise no changes to the text itself beyond the mechanical conversion. Note that the inclusion of the kerneldoc comments from the source has never worked, since exported symbols were asked for and none of those functions are exported to modules. It doesn't work here either :) Cc: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: Move the 802.11 guide into the driver-api manualJonathan Corbet2016-11-298-2/+1
|/ | | | | | | | 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>
* Documentation/process/howto: Only send regression fixes after -rc1Dan Carpenter2016-11-291-9/+10
| | | | | | | | | | The original text was not clear if white space or other harmless patches should be merged in -rc kernels. The discussion at Kernel Summit said that we should be more strict about sending regression fixes only. Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Change the document about iowaitChao Fan2016-11-191-1/+10
| | | | | | | | | | The iowait is not reliable by reading from /proc/stat, so this method to get iowait is not suggested. And we mark it in the document. Signed-off-by: Cao Jin <caoj.fnst@cn.fujitsu.com> Signed-off-by: Chao Fan <fanc.fnst@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'mauro-doc' into docs-nextJonathan Corbet2016-11-1914-337/+737
|\
| * parse-headers.rst: add an introduction to the man pageMauro Carvalho Chehab2016-11-191-2/+24
| | | | | | | | | | | | | | | | The pod2rst tool generated a man page for parse-headers.pl script, but it is better to put it into some context. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * parse-headers.pl: add documentation for this scriptMauro Carvalho Chehab2016-11-193-13/+367
| | | | | | | | | | | | | | | | | | | | | | Provide a man page for parse-headers.pl, describing how to use it. The documentation on ReST format was generated via pod2rst: http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs-rst: doc-guide: split the kernel-documentation.rst contentsMauro Carvalho Chehab2016-11-1912-324/+348
| | | | | | | | | | | | | | | | | | Having the kernel-documentation at the topmost level doesn't allow generating a separate PDF file for it. Also, makes harder to add extra contents. So, place it on a sub-dir. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | doc: Document the new inline struct member kernel-doc styleDaniel Vetter2016-11-191-1/+6
|/ | | | | | | | | | | | | | We don't just need better doc toolchains, we also need better docs for our doc toolchain! v2: Make sure we don't have foo twice (Jani). Cc: Daniel Vetter <daniel@ffwll.ch> Cc: Jani Nikula <jani.nikula@intel.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge remote-tracking branch 'sound/topic/restize-docs' into soundJonathan Corbet2016-11-1956-11271/+10293
|\ | | | | | | Bring in the sphinxification of the sound documentation.
| * ASoC: doc: ReSTize codec_to_codec.txtTakashi Iwai2016-11-112-37/+43
| | | | | | | | | | | | | | | | Yet another simple conversion from a plain text file. Renamed to codec-to-codec.rst to align with others. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * Merge branch 'topic/doc' of ↵Takashi Iwai2016-11-111-0/+103
| |\ | | | | | | | | | git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into topic/restize-docs
| | * ASoC: Codec to codec dai link descriptionanish kumar2016-10-261-0/+103
| | | | | | | | | | | | | | | | | | Signed-off-by: anish kumar <yesanishhere@gmail.com> Acked-by: Charles Keepax <ckeepax@opensource.wolfsonmicro.com> Signed-off-by: Mark Brown <broonie@kernel.org>
| * | ASoC: doc: ReSTize DPCM.txtTakashi Iwai2016-11-112-134/+147
| | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. The file name was renamed to lower letters to align with others. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize jack.txtTakashi Iwai2016-11-112-0/+2
| | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize clocking.txtTakashi Iwai2016-11-112-9/+5
| | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize pops_clicks.txtTakashi Iwai2016-11-112-6/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. The file name was changed from "pops_clicks" to "pops-clicks" to align with others. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize machine.txtTakashi Iwai2016-11-112-9/+14
| | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize platform.txtTakashi Iwai2016-11-112-14/+18
| | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize dapm.txtTakashi Iwai2016-11-112-106/+144
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. The section numbers and the item numbers are dropped to align with the ReST format. Some lists are converted to description lists to be clearer. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize DAI.txtTakashi Iwai2016-11-112-10/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file with slight reformatting / corrections. The file name was changed to lower letters to align with others. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize codec.txtTakashi Iwai2016-11-112-32/+44
| | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. The section numbers are dropped to align with other documents. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ASoC: doc: ReSTize overview.txtTakashi Iwai2016-11-113-29/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Created a new subdirectory, Documentation/sound/soc, for this and other ASoC documents. Since the index page contains the TOC, so "Documentation" section got removed from overview. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ALSA: doc: ReSTize img,spdif-in.txtTakashi Iwai2016-11-102-10/+15
| | | | | | | | | | | | | | | | | | | | | Yet another simple conversion from a plain text file. Put to cards directory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ALSA: doc: ReSTize serial-u16550.txtTakashi Iwai2016-11-102-8/+14
| | | | | | | | | | | | | | | | | | | | | Yet another simple conversion from a plain text file. Put to cards directory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
| * | ALSA: doc: ReSTize hdspm.txtTakashi Iwai2016-11-102-118/+136
| | | | | | | | | | | | | | | | | | | | | | | | | | | A simple conversion from a plain text file. Quite a few reformatting in the end due to the style of the original document. Put to cards directory. Signed-off-by: Takashi Iwai <tiwai@suse.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-03 22:37:19 +0100