summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* doc-rst: Fix compilation of the pdf docbookMauro Carvalho Chehab2016-07-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The rst2pdf tool is a very broken toolchain, with is not capable of parsing complex documents. As such, it doesn't build the media book, failing with: [ERROR] pdfbuilder.py:130 too many values to unpack (using rst2pdf version 0.93.dev-r0 and Sphinx version 1.4.5) So, make it build only the books we know that are safe to build. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> -- Btw, with the standard Sphinx version shipped on Fedora 24 (Sphinx 1.3.1), rst2pdf doesn't build even the simple kernel-documentation, failing with this error: writing Kernel... [ERROR] pdfbuilder.py:130 list index out of range This is a known bug: https://github.com/sphinx-doc/sphinx/issues/1844 So, maybe we should just disable pdf generation from RST for good, as I suspect that maintaining it with a broken toolchain will be a big headache.
* Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-nextMauro Carvalho Chehab2016-07-155-7/+33
|\ | | | | | | | | | | | | | | | | * 'docs-next' of git://git.lwn.net/linux: doc-rst: add an option to ignore DocBooks when generating docs workqueue: Fix a typo in workqueue.txt Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt Documentation/sphinx: skip build if user requested specific DOCBOOKS Documentation: add cleanmediadocs to the documentation targets
| * doc-rst: add an option to ignore DocBooks when generating docsMauro Carvalho Chehab2016-07-101-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | Sometimes, we want to do a partial build, instead of building everything. However, right now, if one wants to build just Sphinx books, it will build also the DocBooks. Add an option to allow to ignore all DocBooks when building documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * workqueue: Fix a typo in workqueue.txtMasanari Iida2016-07-061-1/+1
| | | | | | | | | | | | | | | | This patch fixes a spelling typo in workqueue.txt Signed-off-by: Masanari Iida <standby24x7@gmail.com> Acked-by: Tejun Heo <tj@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txtMasanari Iida2016-07-021-5/+5
| | | | | | | | | | | | | | This patch fix some spelling typo found in ocfs2-online-filecheck.txt Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation/sphinx: skip build if user requested specific DOCBOOKSJani Nikula2016-07-021-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | If the user requested specific DocBooks to be built using 'make DOCBOOKS=foo.xml htmldocs', assume no Sphinx build is desired. This check is transitional, and can be removed once we drop the DocBook build. Cc: Markus Heiser <markus.heiser@darmarit.de> Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx configuration and build") Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: add cleanmediadocs to the documentation targetsJani Nikula2016-07-022-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | This was broken when updating the documentation targets for the Sphinx build, and moving from %docs target pattern to explicitly listed targets. Cc: Markus Heiser <markus.heiser@darmarit.de> Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx configuration and build") Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | [media] docs-rst: Fix some typosMauro Carvalho Chehab2016-07-132-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Those fixes came from patchs from Andrea for the old DocBook documentation. As we're removing it on Kernel 4.8, it doesn't make sense to apply the original patches, but, as the typos were ported to ReST, let's fix the issues there. Suggested-by: Andrea Gelmini <andrea.gelmini@gelma.net> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: increase depth of the main indexMauro Carvalho Chehab2016-07-131-8/+3Star
| | | | | | | | | | | | | | | | | | | | It is useful to have an index with all the book contents somewhere, as it makes easier to seek for something. So, increase maxdepth to 5 for the main index at the beginning of the book. While here, remove the genindex content, as it is bogus. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: fix an undefined referenceMauro Carvalho Chehab2016-07-131-3/+3
| | | | | | | | | | | | Documentation/media/uapi/cec/cec-ioc-dqevent.rst:43: WARNING: undefined label: cec_event_state_change (if the link has no caption the label must precede a section header) Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: improve CEC documentationHans Verkuil2016-07-138-72/+64Star
| | | | | | | | | | | | | | Lots of fixups relating to references. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: fix htmldocs build warningsMauro Carvalho Chehab2016-07-133-4/+4
| | | | | | | | | | | | | | | | Fix those warnings: Documentation/output/videodev2.h.rst:6: WARNING: undefined label: vidioc_unsubscribe_event (if the link has no caption the label must precede a section header) Documentation/media/uapi/v4l/dev-overlay.rst:248: WARNING: Title underline too short. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | Revert "[media] docs-rst: escape [] characters"Mauro Carvalho Chehab2016-07-1368-188/+188
| | | | | | | | | | | | | | | | | | | | This patch touches on places where it shouldn't: image files and code examples. Also, it doesn't fix all array occurrences. So, let's revert it. This reverts commit ffbab694ede33c294e5864a5e0bf4d1474446a71.
* | [media] doc-rst: update CEC_RECEIVEHans Verkuil2016-07-131-25/+41
| | | | | | | | | | | | | | | | | | | | | | The timestamp field was split into rx_ts and tx_ts, and the rx/tx_status fields were moved. Update the doc accordingly. Also fix a bug that stated that a non-zero tx_status field signaled an error. That's not true, since TX_STATUS_OK is 1, not 0. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: escape [] charactersMauro Carvalho Chehab2016-07-1268-188/+188
| | | | | | | | | | | | | | Those characters are used for citations. Better to escape, to avoid them to be misinterpreted. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: use the right markup for footnotesMauro Carvalho Chehab2016-07-1220-94/+94
| | | | | | | | | | | | | | According with ReST spec, footnotes should be like: [#name], and not [name]. So, change them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-g-dv-timings.rst: document interlaced definesHans Verkuil2016-07-122-3/+3
| | | | | | | | | | | | | | | | Document V4L2_DV_PROGRESSIVE and V4L2_DV_INTERLACED and fix missing references. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] pixfmt-006.rst: add missing V4L2_YCBCR_ENC_SMPTE240MHans Verkuil2016-07-122-3/+7
| | | | | | | | | | | | | | Fix missing documentation, and its cross reference. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: fix a missing reference for V4L2_BUF_FLAG_LASTMauro Carvalho Chehab2016-07-122-40/+19Star
| | | | | | | | | | | | | | | | | | | | Fix it by adding a header to the flat-table to match to the list of define symbols. As a side-effect, it also removes some exceptions from videodev2.h.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: reorganize LIRC ReST filesMauro Carvalho Chehab2016-07-126-12/+24
| | | | | | | | | | | | | | Reorganize the LIRC rst files, using "-" instead of "_" on their names, and creating a separate chapter for syscalls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC set mode ioctlsMauro Carvalho Chehab2016-07-125-98/+50Star
| | | | | | | | | | | | | | | | | | | | Add LIRC_SET_[REC|SEND]_MODE ioctls to the corresponding GET functions, and put all LIRC modes altogether. As now everything is already documented on its own ioctl pages, get rid of lirc_ioctl.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_SET_WIDEBAND_RECEIVERMauro Carvalho Chehab2016-07-123-19/+57
| | | | | | | | | | | | | | Put documentation for this ioctl on a separate page and improve it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODEMauro Carvalho Chehab2016-07-123-9/+49
| | | | | | | | | | | | Place documentation for this ioctl on its own page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTSMauro Carvalho Chehab2016-07-123-8/+50
| | | | | | | | | | | | Add a separate page for this ioctl and improve its documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_SET_REC_TIMEOUTMauro Carvalho Chehab2016-07-123-11/+53
| | | | | | | | | | | | Add a separate page for this ioctl and adds the cross-references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_SET_TRANSMITTER_MASKMauro Carvalho Chehab2016-07-123-10/+54
| | | | | | | | | | | | | | Add proper documentation for this ioctl, providing some additional information about its usage. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC set carrier ioctlsMauro Carvalho Chehab2016-07-125-18/+143
| | | | | | | | | | | | | | | | Put each ioctl on its own page and improve documentation, adding cross-references for LIRC_SET_REC_CARRIER_RANGE and LIRC_SET_REC_CARRIER, with can be used together to set a carrier frequency range. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_GET_LENGTH ioctlMauro Carvalho Chehab2016-07-123-11/+46
| | | | | | | | | | | | Put documentation for this ioctl on its own page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_GET_*_TIMEOUT ioctlsMauro Carvalho Chehab2016-07-123-13/+56
| | | | | | | | | | | | | | | | | | Improve the documentation for those ioctls, adding them to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for those ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLEMauro Carvalho Chehab2016-07-123-9/+50
| | | | | | | | | | | | Add a separate page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document LIRC_GET_REC_RESOLUTIONMauro Carvalho Chehab2016-07-123-10/+50
| | | | | | | | | | | | | | | | | | Improve the documentation for this ioctl, adding it to a separate file, in order to look like the rest of the book, and to later allow to generate a man page for this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document ioctl LIRC_GET_REC_MODEMauro Carvalho Chehab2016-07-123-9/+60
| | | | | | | | | | | | | | | | Move the documentation of this ioctl from lirc_ioctl to its own file, and add a short description about the pulse mode used by IR RX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: fix some lirc cross-referencesMauro Carvalho Chehab2016-07-124-7/+6Star
| | | | | | | | | | | | | | | | | | Some references were broken. It was also mentioning LIRC_MODE_RAW, with it is not implemented on current LIRC drivers. So, fix the references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: document ioctl LIRC_GET_SEND_MODEMauro Carvalho Chehab2016-07-113-9/+49
| | | | | | | | | | | | | | | | Move the documentation of this ioctl from lirc_ioctl to its own file, and add a short description about the pulse mode used by IR TX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: Fix LIRC_GET_FEATURES referencesMauro Carvalho Chehab2016-07-112-39/+60
| | | | | | | | | | | | | | | | The references pointed by LIRC_GET_FEATURES ioctl are broken. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: remove not used ioctls from documentationMauro Carvalho Chehab2016-07-112-74/+9Star
| | | | | | | | | | | | | | As we removed those ioctls from the header file, do the same at the documentation side. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] lirc.h: remove several unused ioctlsMauro Carvalho Chehab2016-07-111-37/+2Star
| | | | | | | | | | | | | | | | | | | | | | While reviewing the documentation gaps on LIRC, it was noticed that several ioctls aren't used by any LIRC drivers (nor at staging or mainstream). It doesn't make sense to document them, as they're not used anywhere. So, let's remove those from the lirc header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: add media/uapi/rc/lirc-header.rstMauro Carvalho Chehab2016-07-111-0/+10
| | | | | | | | | | | | | | | | | | | | changeset 68cd5e0bed99 ("[media] doc-rst: add LIRC header to the book") did everything but adding the lirc-reader.rst :-p My fault: I forgot to do a git add for this guy on such changeset. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: Document ioctl LIRC_GET_FEATURESMauro Carvalho Chehab2016-07-114-43/+169
| | | | | | | | | | | | | | | | | | The documentation for this ioctl was really crappy. Add a better documentation, using the lirc.4 man pages as a reference, plus what was written originally at the lirc-ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: improve display of notes and warningsMauro Carvalho Chehab2016-07-1069-526/+592
| | | | | | | | | | | | | | | | | | | | There are several notes and warning mesages in the middle of the media docbook. Use the ReST tags for that, as it makes them visually better and hightlights them. While here, modify a few ones to make them clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: improve DTV_BANDWIDTH_HZ notesMauro Carvalho Chehab2016-07-101-11/+17
| | | | | | | | | | | | | | There are several notes for this DTV property. Some are outdated, so take some care of it, making it updated. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: improve documentation for DTV_FREQUENCYMauro Carvalho Chehab2016-07-101-10/+16
| | | | | | | | | | | | Make the note better formatted and documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: Don't use captions for examplesMauro Carvalho Chehab2016-07-1012-29/+71
| | | | | | | | | | | | | | | | | | | | | | | | Unfortunately, captions are new on Sphinx for c blocks: it was added only on version 1.3. Also, it were already bad enough not being able to auto-numerate them. So, let's give up and use, instead, titles before the examples. Not much is lost, and, as a side track, we don't need to numerate them anymore. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: do cross-references between header and the docMauro Carvalho Chehab2016-07-102-2/+79
| | | | | | | | | | | | | | | | | | | | Now that the LIRC header was added, we can cross-reference it and identify the documentation gaps. There are lots of stuff missing there, but at least now we can avoid the gap to increase. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: add LIRC header to the bookMauro Carvalho Chehab2016-07-103-1/+7
| | | | | | | | | | | | | | Just like the other parts of the document, let's add the LIRC header, as it is part of the API. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: improve LIRC syscall documentationMauro Carvalho Chehab2016-07-103-46/+240
| | | | | | | | | | | | | | | | The lirc syscall documentation uses a very different and simplified way than the rest of the media book. make it closer. Still, there's just one page for all ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: rename some RC filesMauro Carvalho Chehab2016-07-105-4/+4
| | | | | | | | | | | | | | | | | | Some files start with an upper letter. Also, they have big names. rename them. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: remove an extra label on V4L2 and CEC partsMauro Carvalho Chehab2016-07-102-2/+0Star
| | | | | | | | | | | | | | | | There's no need to say: Table of Contents there. Also, this generates a duplicated caption xref. So, remove, to use the same format on every part. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: Group function references together for MCMauro Carvalho Chehab2016-07-102-19/+19
| | | | | | | | | | | | | | Just like the other parts of the media book, group the MC functions together on one chapter. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] doc-rst: media: reordered top sectioningMarkus Heiser2016-07-092-52/+47Star
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Within the old section hierarchy, all doc parts has been placed under the introduction, e.g: * Linux Media Infrastructure API + Introduction - Video for Linux API - Digital TV API - ... With separating the introduction sibling to the other parts we get a more common section hierarchy: * Linux Media Infrastructure API + Introduction + Video for Linux API + Digital TV API + ... BTW: compacting the intro text. This patch is on top of media_tree/docs-next Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
generated by cgit v1.2.3-55-g7522 (git 2.39.0) at 2024-07-10 12:30:00 +0200