- 09 4月, 2017 1 次提交
-
-
由 Tsugikazu Shibata 提交于
This commit adds Japanese translation of HOWTO document into rst based documentation build system with updates. Signed-off-by: NTsugikazu Shibata <tshibata@ab.jp.nec.com> Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 03 4月, 2017 1 次提交
-
-
由 Jonathan Corbet 提交于
This is meant to be the place for documentation relevant to application developers. It's empty for the moment, but at least we have a place now! Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 27 1月, 2017 1 次提交
-
-
由 Andy Deng 提交于
Tested by the command: make htmldocs During the compiling process, zh_CN/coding-style.rst has no errors and warnings generated, the generated html document has been checked. Signed-off-by: NAndy Deng <theandy.deng@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 14 12月, 2016 1 次提交
-
-
由 Stephan Mueller 提交于
With the conversion of the kernel crypto API DocBook to Sphinx, the monolithic document is broken up into individual documents. The documentation is unchanged with the exception of a slight reordering to keep the individual document parts self-contained. Signed-off-by: NStephan Mueller <smueller@chronox.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 30 11月, 2016 1 次提交
-
-
由 Jonathan Corbet 提交于
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: NJonathan Corbet <corbet@lwn.net>
-
- 20 11月, 2016 1 次提交
-
-
由 Mauro Carvalho Chehab 提交于
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: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 14 11月, 2016 1 次提交
-
-
由 SeongJae Park 提交于
This commit adds Korean translation of HOWTO document into rst based documentation build system. Signed-off-by: NSeongJae Park <sj38.park@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 11 11月, 2016 1 次提交
-
-
由 Takashi Iwai 提交于
A simple conversion of alsa-driver-api document from DocBook to ReST. It's moved to the new Documentation/sound/kernel-api subdirectory that will contain other ALSA kernel API documents. The GPL legal note was removed, as it's superfluous (and doesn't fit with ReST kernel docs pretty well). Signed-off-by: NTakashi Iwai <tiwai@suse.de>
-
- 08 11月, 2016 2 次提交
-
-
由 Jarkko Sakkinen 提交于
In order too make Documentation root directory cleaner move the tpm directory under Documentation/security. Signed-off-by: NJarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Jarkko Sakkinen 提交于
Transitioned the tpm_vtpm_proxy documentation to the Sphinx infrastructure and removed parts from the documentation that are easier to pull from the sources. Restructured vtpm_proxy.h and tpm_vtpm_proxy.c to be compatible with this approach and wrote associated documentation comments. Signed-off-by: NJarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 29 10月, 2016 1 次提交
-
-
由 Silvio Fricke 提交于
Signed-off-by: NSilvio Fricke <silvio.fricke@gmail.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 28 10月, 2016 1 次提交
-
-
由 Jonathan Corbet 提交于
This will be the initial landing point for readers, so give them a bit of introductory material. Also split the TOC into area-specific chunks to make the whole thing a bit more approachable. Reviewed-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 27 10月, 2016 1 次提交
-
-
由 Markus Heiser 提交于
Add minimal conf.py and moved dev-tools/tools.rst to dev-tools/index.rst makes the dev-tools folder buildable stand-alone. To build only this folder run:: make SPHINXDIRS=dev-tools htmldocs make SPHINXDIRS=dev-tools pdfdocs Signed-off-by: NMarkus Heiser <markus.heiser@darmarit.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 24 10月, 2016 2 次提交
-
-
由 Mauro Carvalho Chehab 提交于
Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters on an user's manual book. As we'll be numbering the user's manual, remove the manual numbering from SecurityBugs. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
As we'll type this a lot, after adding CodingStyle & friends, let's rename the directory name to a shorter one. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 12 10月, 2016 1 次提交
-
-
由 Johannes Berg 提交于
This is just a very basic conversion, I've split up the original multi-book template, and also split up the multi-part mac80211 part in the original book; neither of those were handled by the automatic pandoc conversion. Fix errors that showed up, resulting in a much nicer rendering, at least for the interface combinations documentation. Signed-off-by: NJohannes Berg <johannes.berg@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 21 9月, 2016 1 次提交
-
-
由 Mauro Carvalho Chehab 提交于
Now that the files at Documentation/development-process/ were converted to ReST, make create a book at Sphinx. As we'll have other books related to the development process, we'll add it as a sub-book. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 23 8月, 2016 2 次提交
-
-
由 Jonathan Corbet 提交于
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: NJonathan Corbet <corbet@lwn.net>
-
由 Jonathan Corbet 提交于
Perform a basic sphinx conversion of the device-drivers docbook and move it to its own directory. Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 19 8月, 2016 2 次提交
-
-
由 Jonathan Corbet 提交于
This directory will be a collecting point for documentation oriented around development tools. As a step toward ordering Documentation/ it's a small one, but we have to start somewhere... Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
由 Markus Heiser 提交于
Add a index if only a sub-folder is build e.g.:: make SPHINXDIRS=media cleandocs htmldocs BTW: removed dead search link in the top-index file Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 15 8月, 2016 1 次提交
-
-
由 Markus Heiser 提交于
With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 19 7月, 2016 1 次提交
-
-
由 Mauro Carvalho Chehab 提交于
The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 18 7月, 2016 3 次提交
-
-
由 Mauro Carvalho Chehab 提交于
Adds documentation for V4L drivers. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Now that all DVB files got converted, add it to Sphinx build. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
由 Mauro Carvalho Chehab 提交于
Move the contents of the media section at DocBooks/DocBook/device-drivers.tmpl to a new ReST book. For now, the contents is kept as-is. Next patches will fix the warnings and add cross-references that were removed due to the conversion. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 08 7月, 2016 1 次提交
-
-
由 Mauro Carvalho Chehab 提交于
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 01 7月, 2016 1 次提交
-
-
由 Markus Heiser 提交于
This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de> Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
-
- 24 6月, 2016 1 次提交
-
-
由 Jani Nikula 提交于
Describe Sphinx, reStructuredText, the kernel-doc extension, the kernel-doc structured documentation comments, etc. The kernel-doc parts are based on kernel-doc-nano-HOWTO.txt, by Tim <twaugh@redhat.com>. Signed-off-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NJonathan Corbet <corbet@lwn.net>
-
- 23 6月, 2016 1 次提交
-
-
由 Jani Nikula 提交于
The modindex is for python modules. Signed-off-by: NJani Nikula <jani.nikula@intel.com>
-
- 21 6月, 2016 1 次提交
-
-
由 Jani Nikula 提交于
This is the first step towards converting the DocBook gpu.tmpl to Sphinx and reStructuredText, the new kernel documentation tool and markup. Use Jon's "cheesy conversion script" in Documentation/sphinx/tmplcvt to do the rough conversion. Do the manual edits in follow-up patches. Add a new Documentation/gpu directories for the graphics related documentation. (Hooray, now we can have directories based on topics rather than tools under Documentation.) We also won't remove the DocBook gpu.tmpl yet so it's easier to build both and compare the results for parity. Signed-off-by: NJani Nikula <jani.nikula@intel.com> Signed-off-by: NDaniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/bc7b4f9ac037632e0c8469c079d21fad5eaa39a0.1466506505.git.jani.nikula@intel.com
-
- 30 5月, 2016 1 次提交
-
-
由 Jani Nikula 提交于
Add basic configuration and makefile to build documentation from any .rst files under Documentation using Sphinx. For starters, there's just the placeholder index.rst. At the top level Makefile, hook Sphinx documentation targets alongside (but independent of) the DocBook toolchain, having both be run on the various 'make *docs' targets. All Sphinx processing is placed into Documentation/Makefile.sphinx. Both that and the Documentation/DocBook/Makefile are now expected to handle all the documentation targets, explicitly ignoring them if they're not relevant for that particular toolchain. The changes to the existing DocBook Makefile are kept minimal. There is graceful handling of missing Sphinx and rst2pdf (which is needed for pdf output) by checking for the tool and python module, respectively, with informative messages to the user. If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but otherwise gracefully fall back to the Sphinx default theme, with an informative message to the user, and slightly less pretty HTML output. Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available), epubdocs and xmldocs targets. The output documents are written into per output type subdirectories under Documentation/output. Finally, you can pass options to sphinx-build using the SPHINXBUILD make variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose output from Sphinx. This is based on the original work by Jonathan Corbet, but he probably wouldn't recognize this as his own anymore. Signed-off-by: NJani Nikula <jani.nikula@intel.com>
-