- 19 Nov, 2016 5 commits
-
-
Jonathan Corbet authored
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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/pod2rstSigned-off-by:
-
Mauro Carvalho Chehab authored
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:
-
Daniel Vetter authored
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:
-
- 18 Nov, 2016 2 commits
-
-
Jonathan Corbet authored
Bring in the sphinxification of the sound documentation.
-
Jonathan Corbet authored
Bring in -rc4 patches so I can successfully merge the sound doc changes.
-
- 16 Nov, 2016 14 commits
-
-
Jani Nikula authored
kernel-doc supports documenting struct members "inline" since a4c6ebed ("scripts/kernel-doc Allow struct arguments documentation in struct body"). This requires the inline kernel-doc comments to have the opening and closing comment markers (/** and */ respectively) on lines of their own, even for short comments. For example: /** * struct foo - struct documentation */ struct foo { /** * @bar: member documentation */ int bar; }; Add support for one line inline comments: /** * struct foo - struct documentation */ struct foo { /** @bar: member documentation */ int bar; }; Note that mixing of the two in one doc comment is not allowed; either both comment markers must be on lines of their own, or both must be on the one line. This limitation keeps both the comments more uniform, and kernel-doc less complicated. Cc: Daniel Vetter <daniel@ffwll.ch> Signed-off-by:
Jani Nikula <jani.nikula@intel.com> Signed-off-by:
-
Brian Norris authored
Per the original author, the proposed document was never deemed necessary, and the important bits got merged into completion.txt. Let's just stop confusing readers by pointing at a nonexistent doc. Signed-off-by:
Brian Norris <briannorris@chromium.org> Signed-off-by:
-
Oliver Neukum authored
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:
-
Mark Rutland authored
While the {READ,WRITE}_ONCE() macros should be used in preference to ACCESS_ONCE(), the circular buffer documentation uses the latter exclusively. To point people in the right direction, and as a step towards the eventual removal of ACCESS_ONCE(), update the documentation to use READ_ONCE(), as ACCESS_ONCE() is only used in a reader context in the circular buffer documentation. Signed-off-by:Mark Rutland <mark.rutland@arm.com> Acked-by:
David Howells <dhowells@redhat.com> Acked-by:
Paul E. McKenney <paulmck@linux.vnet.ibm.com> Signed-off-by:
-
Mark Rutland authored
While the {READ,WRITE}_ONCE() macros should be used in preference to ACCESS_ONCE(), the atomic documentation uses the latter exclusively. To point people in the right direction, and as a step towards the eventual removal of ACCESS_ONCE(), update the documentation to use the {READ,WRITE}_ONCE() macros as appropriate. Signed-off-by: -
Jonathan Corbet authored
There were a few manuals that weren't being built in PDF format, but there's no reason not to... Signed-off-by: -
Jonathan Corbet authored
Mauro says: This series address a series of errors during PDF generation from media documentation. The first patch fixes the late redefinition of a LaTeX command at the Sphinx LaTeX style that causes build to break when some cross-references are used. The next two patches fix PDF output issues with subdev-formats.rst. The next 3 patches fix image includes and their output for PDF. It is aligned with Linus request of not having binary-generated images from their SVG source codes. I still intend to move the remaing PNG images to vectorial ones (SVG), as image scale works better, but this will require some additional work. When done, I'll submit as a separate patch series. It should also be noticed that the last patch violates the output dir, when make is used with "O=some_dir", as Sphinx doesn't accept image files outside the source directory. We'll likely need some Sphinx extension in order to fix it, but at least with this series (plus Jani Nikola's PDF fix series), the PDF output should work fine again. [jc: added a commit fixing up a "make cleandocs" warning]
-
Jonathan Corbet authored
Recent Makefile changes added an rm command without the requisite "-f", leading to warnings if the files do not exist. Make it be quiet again. Signed-off-by: -
Mauro Carvalho Chehab authored
The PDF files that contain media images were actually generated offline from their SVG or PNG source files. Sphinx can handle PNG sources automatially. So, let's just drop their PDF counterparts. For SVG, however, Sphinx doesn't produce the right tags to use the TexLive SVG support. Also, the SVG support is done via shell execution, with is not nice. So, while we don't have any support for SVG inside Sphinx core or as an extension, move the logic to build them to Makefile, producing the PDF images on runtime. NOTE: due to the way Sphinx works, the PDF images should be generated inside the Kernel source tree, as otherwise Sphinx won't find it, not obeying what's specified by "O=" makefile parameter. Signed-off-by:
-
Mauro Carvalho Chehab authored
Right now, media is using two different formats for bitmap images: GIF and PNG. Let's use just one, to make it simpler when building with Sphinx. As PNG is usually better than GIF, let's use it. Signed-off-by:
-
Mauro Carvalho Chehab authored
SVG images are nicer, as they can easily be scaled. Also, they're written in text, with makes easier to work. Signed-off-by:
-
Mauro Carvalho Chehab authored
There are several missing columns on the size specification, causing LaTeX to complain on interactive mode. Signed-off-by:
-
Mauro Carvalho Chehab authored
adjustbox doesn't work on longtables. Also, this causes an error on LaTeX in interactive mode. So, use, instead, a tiny font. Signed-off-by:
-
Mauro Carvalho Chehab authored
PDF build on Kernel 4.9-rc? returns an error with Sphinx 1.3.x and Sphinx 1.4.x, when trying to solve some cross-references. The solution is to redefine the \DURole macro. However, this is redefined too late. Move such redefinition to LaTeX preamble and bind it to just the Sphinx versions where the error is known to be present. Tested by building the documentation on interactive mode: make PDFLATEX=xelatex -C Documentation/output/./latex Fixes: e61a39ba ("[media] index.rst: Fix LaTeX error in interactive mode on Sphinx 1.4.x") Signed-off-by:
-
- 13 Nov, 2016 4 commits
-
-
Jonathan Corbet authored
Update the F: line accordingly. Signed-off-by: -
SeongJae Park authored
This commit adds Korean translation of HOWTO document into rst based documentation build system. Signed-off-by:
SeongJae Park <sj38.park@gmail.com> Signed-off-by:
-
SeongJae Park authored
Signed-off-by:
-
SeongJae Park authored
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:
-
- 11 Nov, 2016 12 commits
-
-
Takashi Iwai authored
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>
-
Takashi Iwai authored
Merge branch 'topic/doc' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into topic/restize-docs
-
Takashi Iwai authored
A simple conversion from a plain text file. The file name was renamed to lower letters to align with others. Acked-by:
-
Takashi Iwai authored
A simple conversion from a plain text file. Acked-by:
-
Takashi Iwai authored
A simple conversion from a plain text file. Acked-by:
-
Takashi Iwai authored
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:
-
Takashi Iwai authored
A simple conversion from a plain text file. Acked-by:
-
Takashi Iwai authored
A simple conversion from a plain text file. Acked-by:
-
Takashi Iwai authored
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:
-
Takashi Iwai authored
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:
-
Takashi Iwai authored
A simple conversion from a plain text file. The section numbers are dropped to align with other documents. Acked-by:
-
Takashi Iwai authored
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:
-
- 10 Nov, 2016 3 commits
-
-
Takashi Iwai authored
Yet another simple conversion from a plain text file. Put to cards directory. Signed-off-by: -
Takashi Iwai authored
Yet another simple conversion from a plain text file. Put to cards directory. Signed-off-by: -
Takashi Iwai authored
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:
-
