summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* usb/power-management.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-191/+214
| | | | | | | | | This document describe some USB core functions. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* usb/callbacks.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-19/+43
| | | | | | | | | This document describe some USB core functions. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* usb/bulk-streams.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-4/+10
| | | | | | | | | This document describe some USB core functions. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* usb/anchors.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-16/+21
| | | | | | | | | This document describe some USB core functions. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* writing_musb_glue_layer.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-315/+301
| | | | | | | | | | | | | | | | | | | | | | | This file is actually quite complex, and required several manual handwork: - add a title for the document; - use the right tags for monospaced fonts; - use c references where needed; - adjust cross-reference to writing_usb_driver.rst - hightlight cross-referenced lines. With regards to C code snippet line highlights, the better would be to use :linenos: for the C code snippets that are referenced by the line number. However, at least with Sphinx 1.4.9, enabling it cause the line number to be misaligned with the code, making it even more confusing. So, instead, let's use :emphasize-lines: tag to mark the lines that are referenced at the text. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* writing_usb_driver.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-100/+82
| | | | | | | | | | | | | | The pandoc conversion is not perfect. Do handwork in order to: - add a title to this chapter; - adjust function and struct references; - use monospaced fonts for C code names; - some other minor adjustments to make it better to read in text mode and in html. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* gadget.rst: Enrich its ReST representation and add kernel-doc tagMauro Carvalho Chehab2017-04-111-75/+52
| | | | | | | | | | | | | | | The pandoc conversion is not perfect. Do handwork in order to: - add a title to this chapter; - use the proper warning and note markups; - use kernel-doc to include Kernel header and c files; - remove legacy notes with regards to DocBook; - some other minor adjustments to make it better to read in text mode and in html. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* usb.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-31/+17
| | | | | | | | | | | | - use the proper warning and note markups; - add references for parts of the document that will be cross-referenced on other USB docs; - some minor adjustments to make it better to read in text mode and in html. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: convert usb docbooks to ReSTMauro Carvalho Chehab2017-04-1110-2170/+1722
| | | | | | | | | | | | | As we're moving out of DocBook, let's convert the remaining USB docbooks to ReST. The transformation itself on this patch is a no-brainer conversion using pandoc via this script: Documentation/sphinx/tmplcvt Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* driver-api/basics.rst: add device table headerMauro Carvalho Chehab2017-04-111-0/+6
| | | | | | | | The structs there at device table are used by other documentation at the Kernel. So, add it to the driver API. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* tmplcvt: make the tool more robustMauro Carvalho Chehab2017-04-111-2/+11
| | | | | | | | | | | | | | | | Currently, the script just assumes to be called at Documentation/sphinx/. Change it to work on any directory, and make it abort if something gets wrong. Also, be sure that both parameters are specified. That should avoid troubles like this: $ Documentation/sphinx/tmplcvt Documentation/DocBook/writing_usb_driver.tmpl sed: couldn't open file convert_template.sed: No such file or directory Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'user-space-api' into docs-nextJonathan Corbet2017-04-084-79/+164
|\ | | | | | | | | Create a beginning user-space API manual, and add one old doc that nobody cares much about. More useful stuff should come soon...
| * docs: Convert unshare.txt to RST and add to the user-space API manualJonathan Corbet2017-04-022-79/+118
| | | | | | | | | | | | | | | | This is a straightforward conversion, without any real textual changes. Since this document has seen no substantive changes since its addition in 2006, some such changes are probably warranted. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Create a user-space API guideJonathan Corbet2017-04-023-0/+46
| | | | | | | | | | | | | | 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: Jonathan Corbet <corbet@lwn.net>
* | Documentation: stable-kernel-rules: fix stable-tag formatJohan Hovold2017-04-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | A patch documenting how to specify which kernels a particular fix should be backported to (seemingly) inadvertently added a minus sign after the kernel version. This particular stable-tag format had never been used prior to this patch, and was neither present when the patch in question was first submitted (it was added in v2 without any comment). Drop the minus sign to avoid any confusion. Fixes: fdc81b7910ad ("stable_kernel_rules: Add clause about specification of kernel versions to patch.") Signed-off-by: Johan Hovold <johan@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | Documentation: Add HOWTO Japanese translation into rst based build systemTsugikazu Shibata2017-04-083-286/+330
|/ | | | | | | | | This commit adds Japanese translation of HOWTO document into rst based documentation build system with updates. Signed-off-by: Tsugikazu Shibata <tshibata@ab.jp.nec.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-api.rst: fix a series of errors when parsing C filesmchehab@s-opensource.com2017-04-029-26/+36
| | | | | | | | | | | | | | | | | | | | | | ./lib/string.c:134: WARNING: Inline emphasis start-string without end-string. ./mm/filemap.c:522: WARNING: Inline interpreted text or phrase reference start-string without end-string. ./mm/filemap.c:1283: ERROR: Unexpected indentation. ./mm/filemap.c:3003: WARNING: Inline interpreted text or phrase reference start-string without end-string. ./mm/vmalloc.c:1544: WARNING: Inline emphasis start-string without end-string. ./mm/page_alloc.c:4245: ERROR: Unexpected indentation. ./ipc/util.c:676: ERROR: Unexpected indentation. ./drivers/pci/irq.c:35: WARNING: Block quote ends without a blank line; unexpected unindent. ./security/security.c:109: ERROR: Unexpected indentation. ./security/security.c:110: WARNING: Definition list ends without a blank line; unexpected unindent. ./block/genhd.c:275: WARNING: Inline strong start-string without end-string. ./block/genhd.c:283: WARNING: Inline strong start-string without end-string. ./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string. ./include/linux/clk.h:134: WARNING: Inline emphasis start-string without end-string. ./ipc/util.c:477: ERROR: Unknown target name: "s". Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Bjorn Helgaas <bhelgaas@google.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-api.rst: fix some complex tags at lib/bitmap.cmchehab@s-opensource.com2017-04-021-11/+17
| | | | | | | | | | | | | Fix the following issues: ./lib/bitmap.c:869: WARNING: Definition list ends without a blank line; unexpected unindent. ./lib/bitmap.c:876: WARNING: Inline emphasis start-string without end-string. ./lib/bitmap.c:508: ERROR: Unexpected indentation. And make sure that a table and a footnote will use the right tags. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-api.rst: fix output of the vsnprintf() documentationmchehab@s-opensource.com2017-04-021-3/+3
| | | | | | | | | | The vsnprintf() kernel-doc comment uses % character with a special meaning other than escaping a constant. As ReST already defines ``literal`` as an escape sequence, let's make kernel-doc handle it, and use it at lib/vsprintf.c. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: core_api: move driver-specific stuff to drivers_apiMauro Carvalho Chehab2017-04-026-72/+73
| | | | | | | | | There are several stuff there that are actually driver-specific. Move those to the driver_api book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-api.rst: make it handle lib/crc32.cMauro Carvalho Chehab2017-04-021-1/+0
| | | | | | | | This file has only "internal" functions: ./lib/crc32.c:1: warning: no structured comments found Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* kernel-api.tmpl: convert it to ReSTMauro Carvalho Chehab2017-04-024-332/+421
| | | | | | | | Brainless conversion of genericirq.tmpl book to ReST, via Documentation/sphinx/tmplcvt Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* genericirq.rst: add cross-reference links and use monospaced fontsMauro Carvalho Chehab2017-04-021-51/+46
| | | | | | | | | | | The document describes several functions that are documented there via kernel doc macros. Add cross-references to them. In order to be consistend with other documents, use monospaced fonts for fields. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* genericirq.tmpl: convert it to ReSTMauro Carvalho Chehab2017-04-024-521/+447
| | | | | | | | | | Brainless conversion of genericirq.tmpl book to ReST, via Documentation/sphinx/tmplcvt Copyright information inserted manually. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/kernel-doc: fix handling of parameters with parenthesisMauro Carvalho Chehab2017-04-021-4/+3
| | | | | | | | | | | | | | | lib/crc32c defines one parameter as: const u32 (*tab)[256] Better handle parenthesis, to avoid those warnings: ./lib/crc32.c:149: warning: No description found for parameter 'tab)[256]' ./lib/crc32.c:149: warning: Excess function parameter 'tab' description in 'crc32_le_generic' ./lib/crc32.c:294: warning: No description found for parameter 'tab)[256]' ./lib/crc32.c:294: warning: Excess function parameter 'tab' description in 'crc32_be_generic' Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/kernel-doc: fix parser for apostrophesMauro Carvalho Chehab2017-04-021-1/+11
| | | | | | | | | | | On ReST, adding a text like ``literal`` is valid. However, the kernel-doc script won't handle it fine. We really need this feature, in order to escape things like %ph, with is found on some C files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Use sphinx.version_info directly instead of parsingRémy Léone2017-03-312-3/+3
| | | | | | | | Using the development version of sphinx caused the parsing of the version to fail. Signed-off-by: Rémy Léone <remy.leone@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* sparse doc: fix reference pathCao jin2017-03-312-4/+4
| | | | | | | | Documentation/sparse.txt has been moved to Documentation/dev-tools/sparse.rst Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* pci-error-recovery: doc cleanupCao jin2017-03-291-6/+6
| | | | | | | | Include whitespace shooting; correction; typo fix; superfluous word dropping. Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: Fix dead URLs to ftp.kernel.orgSeongJae Park2017-03-2912-25/+19
| | | | | | | | | | | | | As ftp.kernel.org is closed [0], this commit fixes dead URLs in documents to use www.kernel.org instead. [0] https://www.kernel.org/shutting-down-ftp-services.html Signed-off-by: SeongJae Park <sj38.park@gmail.com> Acked-by: Theodore Ts'o <tytso@mit.edu> Acked-by: David S. Miller <davem@davemloft.net> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: Add flexible-arrays.rst to the documentation treesayli karnik2017-03-293-0/+198
| | | | | | | | Add flexible-arrays.rst to Documentation/core-api. Add kernel-doc comments to allow referencing. Signed-off-by: sayli karnik <karniksayli1995@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: device-mapper: cache.txt: Fix typossayli karnik2017-03-191-1/+1
| | | | | | | Fix a spelling error (hexidecimal->hexadecimal). Signed-off-by: sayli karnik <karniksayli1995@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: md: md-cluster.txt: Fix typosTamara Diaconita2017-03-171-1/+1
| | | | | | | Fix typos in md-cluster.txt file to make documentation clear. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: mmc: mmc-dev-attrs.txt: Fix typosTamara Diaconita2017-03-171-2/+2
| | | | | | | Fix typos in mmc-dev-attrs.txt to make documentation clear. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentaion: leds: leds-lp55xx.txt: Fix typosTamara Diaconita2017-03-171-1/+1
| | | | | | | | Fix spelling mistakes in leds-lp55xx.txt file to make documentation clear. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: vfio-mediated-device.txt: Fix typosTamara Diaconita2017-03-171-1/+1
| | | | | | | | Correct spelling mistakes in vfio-mediates-device.txt to make documentation clear. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: sync_file.txt: Fix typosTamara Diaconita2017-03-171-1/+1
| | | | | | | Fix spelling mistakes in sync_file.txt to make documentation clear. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* lib/Kconfig.debug: correct documentation pathsHans Holmberg2017-03-171-4/+5
| | | | | | | A bunch of documentation files have moved, correct the paths. Signed-off-by: Hans Holmberg <hans@pixelmunchies.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: acpi: Fix typosTamara Diaconita2017-03-173-7/+7
| | | | | | | Fix typos in acpi directory to make documentation grammatically correct. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: admin-guide: Fix typosTamara Diaconita2017-03-142-7/+7
| | | | | | | | Fix typos in admin-guide directory. Make documentation clear and grammatically correct. Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: input: fix path to struct ff_effect's definitionMartin Kepplinger2017-03-131-3/+3
| | | | | | | | The UAPI header split failed to update the documentation here; fix things accordingly. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: admin-guide: fix path to input key definitionsMartin Kepplinger2017-03-131-1/+2
| | | | | | | | The UAPI header split failed to update the documentation here; fix things accordingly. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: input: fix path to input code defnitionsMartin Kepplinger2017-03-131-2/+2
| | | | | | | | The UAPI header split failed to update the documentation in input-programming.txt; fix things accordingly. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: hid: fix path to input bus definitionsMartin Kepplinger2017-03-131-1/+1
| | | | | | | | The UAPI header split failed to update the documentation here; fix things accordingly. Signed-off-by: Martin Kepplinger <martink@posteo.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: ABI: vdso: update parse_vdso.c referenceBaruch Siach2017-03-131-1/+2
| | | | | | | | | Since commit f9b6b0ef603 ("selftests: move vDSO tests from Documentation/vDSO") parse_vdso.c moved under selftests. Update the reference to match. Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Baruch Siach <baruch@tkos.co.il> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* cpufreq: User/admin documentation update and consolidationRafael J. Wysocki2017-03-137-629/+716
| | | | | | | | | | | | | | | | | | | The user/admin documentation of cpufreq is badly outdated. It conains stale and/or inaccurate information along with things that are not particularly useful. Also, some of the important pieces are missing from it. For this reason, add a new user/admin document for cpufreq containing current information to admin-guide and drop the old outdated .txt documents it is replacing. Since there will be more PM documents in admin-guide going forward, create a separate directory for them and put the cpufreq document in there right away. Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Acked-by: Viresh Kumar <viresh.kumar@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: Don't use explicit Makefile rules to build SVG and DOT filesMauro Carvalho Chehab2017-03-1310-91/+45
| | | | | | | Now that we have an extension to handle images, use it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: automatically convert Graphviz and SVG imagesMarkus Heiser2017-03-096-6/+665
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch brings scalable figure, image handling and a concept to embed *render* markups: * DOT (http://www.graphviz.org) * SVG For image handling use the 'image' replacement:: .. kernel-image:: svg_image.svg :alt: simple SVG image For figure handling use the 'figure' replacement:: .. kernel-figure:: svg_image.svg :alt: simple SVG image SVG image example Embed *render* markups (or languages) like Graphviz's **DOT** is provided by the *render* directive.:: .. kernel-render:: DOT :alt: foobar digraph :caption: Embedded **DOT** (Graphviz) code. digraph foo { "bar" -> "baz"; } The *render* directive is a concept to integrate *render* markups and languages, yet supported markups: * DOT: render embedded Graphviz's **DOT** * SVG: render embedded Scalable Vector Graphics (**SVG**) Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Tested-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Tested-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> (v2 - v5) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> (v1, v6) Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: Explain light-handed markup preference a bit betterDaniel Vetter2017-03-091-1/+16
| | | | | | | | | | | | | | | | We're still pretty far away from anything like a consensus, but there's clearly a lot of people who prefer an as-light as possible approach to converting existing .txt files to .rst. Make sure this is properly taken into account and clear. Motivated by discussions with Peter and Christoph and others. Cc: Christoph Hellwig <hch@infradead.org> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Jani Nikula <jani.nikula@linux.intel.com> Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: cpu-freq: cpu-drivers: Fix repetition of word 'to'sayli karnik2017-03-091-1/+1
| | | | | | | | The patch replaces 'to to' with 'to' in the documentation. Signed-off-by: sayli karnik <karniksayli1995@gmail.com> Acked-by: Viresh Kumar <viresh.kumar@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.25.1) at 2025-03-10 02:22:38 +0000