summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* [media] extract_xc3028.pl: move it to scripts/dirMauro Carvalho Chehab2016-07-171-0/+0
| | | | | | This doesn't belong at documentation. Move it to scripts. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] add DVB documentation to SphinxMauro Carvalho Chehab2016-07-171-0/+1
| | | | | | | Now that all DVB files got converted, add it to Sphinx build. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: convert udev chapter to rstMauro Carvalho Chehab2016-07-172-8/+24
| | | | | | | | This chapter is outdated. I almost removed, but, as we're lacking documentation about how to make DVB devices persistent, I opted, instead, to keep it, and add a note about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: convert ttusb-dev to rstMauro Carvalho Chehab2016-07-172-24/+23
| | | | | | | | There are some things that needed to be done to convert it to ReST. Also, there are some obsolete info there related to Kernels 2.4 and 2.6. Update them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert technisat document to ReSTMauro Carvalho Chehab2016-07-172-52/+73
| | | | | | | This document need some changes to be properly parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: add opera-firmware.rst to DVB docsMauro Carvalho Chehab2016-07-172-5/+10
| | | | | | | | | | | This file is shown OK with ReST. Yet, as we changed the place where the get_dvb_firmware script is, we need to update it. While here, move the author's name to the beginning of the file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert lmedm04 to rst formatMauro Carvalho Chehab2016-07-172-24/+49
| | | | | | | | This file was missing a name for the index, and weren't using any markup language. Make it looks better and convert to ReST. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: convert DVB FAQ to ReST formatMauro Carvalho Chehab2016-07-172-5/+14
| | | | | | | Convert the DVB FAQ to ReST format and add a note that this is outdated. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert dvb-usb to ReST formatMauro Carvalho Chehab2016-07-172-97/+221
| | | | | | | This file is not on any markup language. Convert it to ReST format. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert contributors list to ReSTMauro Carvalho Chehab2016-07-172-68/+102
| | | | | | | | | | The contributors list needs some adjustments to be properly formatted. Also, this list has not been updated for a while. So, add a notice about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert ci.txt to a rst fileMauro Carvalho Chehab2016-07-172-84/+103
| | | | | | | | | | The old ci.txt file had a very peculiar format, with doesn't match any markup language I know. Change it to be on ReST format, for it to be parsed by Sphinx. Also, as this is an old document, add a note about it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: convert cards to rst formatMauro Carvalho Chehab2016-07-172-25/+47
| | | | | | | | This file is using a markup-like language, but it is not quite ReST. Convert it, and add a note pointing to the Wiki page with the known supported hardware devices. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: convert bt8xx doc to rstMauro Carvalho Chehab2016-07-172-48/+73
| | | | | | | This document almost follows a markup language, but it is not ReST. Fix it to be handled by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix format of avermedia.rstMauro Carvalho Chehab2016-07-172-279/+246
| | | | | | | | | | This file is almost at the ReST format, but some things need to be fixed for it to be parsed. Also, the documentation there is old. So, add a notice about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move DVB introduction to a separate fileMauro Carvalho Chehab2016-07-172-55/+35
| | | | | | | | | | | Instead of keeping the introduction together with the index, move it to a separate file, and add it via toctree at the index. The information there are outdated, so update it to point to the right links. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: move DVB avulse docs to Documentation/mediaMauro Carvalho Chehab2016-07-1714-0/+0
| | | | | | | | | | | There are several documentation stuff under Documentation/dvb. Move them to Documentation/media/dvb-drivers and rename them to rst, as they'll soon be converted to rst files. No changes at the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for dvb-core.rstMauro Carvalho Chehab2016-07-172-58/+72
| | | | | | | | | | | | | | | | | | The conversion from DocBook required some fixes: - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - Fix the cross-references at the media controller description. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for MC core functionsMauro Carvalho Chehab2016-07-173-130/+163
| | | | | | | | | | | | | | | | | | | | | | There were lots of issues at the media controller side, after the conversion: - Some documentation at the header files weren't using the kernel-doc start block; - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - Fix the cross-references at the media controller description. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix conversion for v4l2 core functionsMauro Carvalho Chehab2016-07-176-24/+70
| | | | | | | | | | | | | | | | | | | | | | | | | | The conversion from DocBook lead into some conversion issues, basically due to the lack of proper support at kernel-doc. So, address them: - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - kernel-doc doesn't escape things like *pointer, so we need to manually add a escape char before it. - On some cases, kernel-doc conversion requires violating the 80-cols, as otherwise it won't properly parse the source code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Fix issues with RC documentationMauro Carvalho Chehab2016-07-174-4/+69
| | | | | | | The kernel-doc script is now broken if it doesn't find all exported symbols documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: split media_drivers.rst into one file per API typeMauro Carvalho Chehab2016-07-175-415/+428
| | | | | | | | Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: media_drivers.rst: Fix paragraph headers for MCMauro Carvalho Chehab2016-07-171-17/+24
| | | | | | | Fix the paragraph identation for the media controller headers. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: Convert media API to rstMauro Carvalho Chehab2016-07-176-379/+423
| | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* 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/+3
| | | | | | | | | | | | | | | | | | | | 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/+64
| | | | | | | | | | | | | | 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/+19
| | | | | | | | | | | | | | | | | | | | 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/+50
| | | | | | | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-20 01:44:29 +0100