summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'docs-4.12' of git://git.lwn.net/linuxLinus Torvalds2017-05-02132-5417/+6111
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull documentation update from Jonathan Corbet: "A reasonably busy cycle for documentation this time around. There is a new guide for user-space API documents, rather sparsely populated at the moment, but it's a start. Markus improved the infrastructure for converting diagrams. Mauro has converted much of the USB documentation over to RST. Plus the usual set of fixes, improvements, and tweaks. There's a bit more than the usual amount of reaching out of Documentation/ to fix comments elsewhere in the tree; I have acks for those where I could get them" * tag 'docs-4.12' of git://git.lwn.net/linux: (74 commits) docs: Fix a couple typos docs: Fix a spelling error in vfio-mediated-device.txt docs: Fix a spelling error in ioctl-number.txt MAINTAINERS: update file entry for HSI subsystem Documentation: allow installing man pages to a user defined directory Doc/PM: Sync with intel_powerclamp code behavior zr364xx.rst: usb/devices is now at /sys/kernel/debug/ usb.rst: move documentation from proc_usb_info.txt to USB ReST book convert philips.txt to ReST and add to media docs docs-rst: usb: update old usbfs-related documentation arm: Documentation: update a path name docs: process/4.Coding.rst: Fix a couple of document refs docs-rst: fix usb cross-references usb: gadget.h: be consistent at kernel doc macros usb: composite.h: fix two warnings when building docs usb: get rid of some ReST doc build errors usb.rst: get rid of some Sphinx errors usb/URB.txt: convert to ReST and update it usb/persist.txt: convert to ReST and add to driver-api book usb/hotplug.txt: convert to ReST and add to driver-api book ...
| * docs: Fix a couple typosStan Drozd2017-04-274-5/+5
| | | | | | | | | | | | | | | | | | | | | | This commit gets rid of some minor errors in Documentation/: * cputopology.txt: drawes -> drawers * debugging-via-ohci1394.txt: remove an unnecessary line break * static-keys: statemnts -> statements * zorro.txt: busses -> buses Signed-off-by: Stan Drozd <drozdziak1@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Fix a spelling error in vfio-mediated-device.txtStan Drozd2017-04-271-3/+3
| | | | | | | | | | | | | | | | This commit fixes a repeated "the" in vfio-mediated-device.txt and reflows the paragraph. Signed-off-by: Stan Drozd <drozdziak1@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: Fix a spelling error in ioctl-number.txtStan Drozd2017-04-271-1/+1
| | | | | | | | | | | | | | This commit fixes a misspelled header name in the ioctl numbers list Signed-off-by: Stan Drozd <drozdziak1@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * MAINTAINERS: update file entry for HSI subsystemTobias Klauser2017-04-271-1/+1
| | | | | | | | | | | | | | | | | | The HSI documentation was moved into Documentation/driver-api/hsi.rst in commit 5e995786850e ("docs: split up serial-interfaces.rst"). Update the corresponding file entry in MAINTAINERS. Signed-off-by: Tobias Klauser <tklauser@distanz.ch> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: allow installing man pages to a user defined directoryHerton R. Krzesinski2017-04-201-3/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Documentation/DocBook/Makefile hard codes the prefixed path to which you can install the built man pages (/usr/local prefix). That's unfortunate since the user may want to install to another prefix or location (for example, a distribution packaging the man pages may want to install to a random temporary location in the build process). Be flexible and allow the prefixed path to which we install man pages to be changed with the INSTALL_MAN_PATH environment variable (and use the same default as other similar variables like INSTALL_HDR_PATH). Signed-off-by: Herton R. Krzesinski <herton@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Doc/PM: Sync with intel_powerclamp code behaviorJacob Pan2017-04-201-5/+15
| | | | | | | | | | | | | | | | | | | | | | | | Commit feb6cd6a0f9f ("thermal/intel_powerclamp: stop sched tick in forced idle") changed how idle injection accouting, so we need to update the documentation accordingly. This patch also expands more details on the behavior of cur_state. Signed-off-by: Jacob Pan <jacob.jun.pan@linux.intel.com> Reported-by: Wang, Xiaolong <xiaolong.wang@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * zr364xx.rst: usb/devices is now at /sys/kernel/debug/Mauro Carvalho Chehab2017-04-201-1/+1
| | | | | | | | | | | | | | | | | | The /proc/bus/usb/devices got moved to sysfs. It is now sitting at: /sys/kernel/debug/usb/devices Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * usb.rst: move documentation from proc_usb_info.txt to USB ReST bookMauro Carvalho Chehab2017-04-202-424/+405
| | | | | | | | | | | | | | | | | | | | | | | | | | The contents of proc_usb_info.txt complements what's there at driver-api usb book. Yet, it is outdated, as it still refers to the USB character devices as usbfs. So, move the contents to usb.rst, adjusting it to point to the right places. 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>
| * convert philips.txt to ReST and add to media docsMauro Carvalho Chehab2017-04-202-6/+16
| | | | | | | | | | | | | | | | | | | | The philips.txt file were at the wrong place: it should be, instead, at Documentation/media. Move and convert it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs-rst: usb: update old usbfs-related documentationMauro Carvalho Chehab2017-04-205-134/+74
| | | | | | | | | | | | | | | | | | | | | | | | There's no usbfs anymore. The old features are now either exported to /dev/bus/usb or via debugfs. Update documentation accordingly, pointing to the new places where the character devices and usb/devices are now placed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * arm: Documentation: update a path namePerr Zhang2017-04-201-1/+1
| | | | | | | | | | | | | | | | the path in the example cmd is out of date, and the path for now is also mentioned in the same file Signed-off-by: Perr Zhang <strongbox8@zoho.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs: process/4.Coding.rst: Fix a couple of document refsAndrew Clayton2017-04-202-8/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In Documentation/process/4.Coding.rst there were a couple of paragraphs that spilled over the 80 character line length. This was likely caused when the document was converted to reStructuredText. Re-flow the paragraphs and make the document references proper reStructuredText :ref: links. This also adds the appropriate reStructuredText file heading to kernel-parameters.rst as referenced by the kernel-parameters link in this patch. Signed-off-by: Andrew Clayton <andrew@digital-domain.net> Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * docs-rst: fix usb cross-referencesMauro Carvalho Chehab2017-04-1110-9/+15
| | | | | | | | | | | | | | | | | | As some USB documentation files got moved, adjust their cross-references to their new place. 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: gadget.h: be consistent at kernel doc macrosMauro Carvalho Chehab2017-04-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | There's one value that use spaces instead of tabs to ident. That causes the following warning: ./include/linux/usb/gadget.h:193: ERROR: Unexpected indentation. 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: composite.h: fix two warnings when building docsMauro Carvalho Chehab2017-04-111-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | By definition, we use /* private: */ tag when we won't be documenting a parameter. However, those two parameters are documented: ./include/linux/usb/composite.h:510: warning: Excess struct/union/enum/typedef member 'setup_pending' description in 'usb_composite_dev' ./include/linux/usb/composite.h:510: warning: Excess struct/union/enum/typedef member 'os_desc_pending' description in 'usb_composite_dev' So, we need to use /* public: */ to avoid a warning. 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: get rid of some ReST doc build errorsMauro Carvalho Chehab2017-04-112-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | We need an space before a numbered list to avoid those warnings: ./drivers/usb/core/message.c:478: ERROR: Unexpected indentation. ./drivers/usb/core/message.c:479: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/linux/usb/composite.h:455: ERROR: Unexpected indentation. ./include/linux/usb/composite.h:456: WARNING: Block quote ends without a blank line; unexpected unindent. 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: get rid of some Sphinx errorsMauro Carvalho Chehab2017-04-111-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | Get rid of those warnings: Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_type". Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_dir". Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_recip". Documentation/driver-api/usb/usb.rst:679: ERROR: Unknown target name: "usbdevfs_urb_type". 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/URB.txt: convert to ReST and update itMauro Carvalho Chehab2017-04-113-97/+127
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The URB doc describes the Kernel mechanism that do USB transfers. While the functions are already described at urb.h, there are a number of concepts and theory that are important for USB driver developers. Convert it to ReST and use C ref links to point to the places at usb.h where each function and struct is located. A few of those descriptions were incomplete. While here, update to reflect the current API status. 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/persist.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-9/+14
| | | | | | | | | | | | | | | | | | This document describe some USB core features. 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/hotplug.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-31/+38
| | | | | | | | | | | | | | | | | | This document describe some USB core features. 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>
| * error-codes.rst: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-113-175/+206
| | | | | | | | | | | | | | | | | | This document describe some USB core features. 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/dma.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-24/+28
| | | | | | | | | | | | | | | | | | This document describe some USB core features. 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/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>
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-02 22:32:13 +0100