summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
...
| | * | doc-rst: add stand-alone conf.py to gpu folderMarkus Heiser2016-08-141-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the gpu/conf.py, the gpu folder can be build and distributed stand-alone. To compile only the html of 'gpu' folder use:: make SPHINXDIRS="gpu" htmldocs Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * | doc-rst: add media/conf_nitpick.pyMarkus Heiser2016-08-141-0/+93
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The media/conf_nitpick.py is a *build-theme* wich uses the nit-picking mode of sphinx. To compile only the html of 'media' with the nit-picking build use:: make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs With this, the Documentation/conf.py is read first and updated with the configuration values from the Documentation/media/conf_nitpick.py. The origin media/conf_nitpick.py comes from Mauro's experimental docs-next branch:: https://git.linuxtv.org/mchehab/experimental.git mchehab/docs-next BTW fixed python indentation in media/conf_nitpick.py. Python indentation is 4 spaces [1] and Python 3 disallows mixing the use of tabs and spaces for indentation [2]. [1] https://www.python.org/dev/peps/pep-0008/#indentation [2] https://www.python.org/dev/peps/pep-0008/#tabs-or-spaces Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * | doc-rst: add stand-alone conf.py to media folderMarkus Heiser2016-08-143-6/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the media/conf.py, and media/index.rst the media folder can be build and distributed stand-alone. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * | doc-rst: generic way to build only sphinx sub-foldersMarkus Heiser2016-08-144-7/+82
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a generic way to build only a reST sub-folder with or without a individual *build-theme*. * control *sub-folders* by environment SPHINXDIRS * control *build-theme* by environment SPHINX_CONF Folders with a conf.py file, matching $(srctree)/Documentation/*/conf.py can be build and distributed *stand-alone*. E.g. to compile only the html of 'media' and 'gpu' folder use:: make SPHINXDIRS="media gpu" htmldocs To use an additional sphinx-build configuration (*build-theme*) set the name of the configuration file to SPHINX_CONF. E.g. to compile only the html of 'media' with the *nit-picking* build use:: make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs With this, the Documentation/conf.py is read first and updated with the configuration values from the Documentation/media/conf_nitpick.py. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | | Merge branch 'doc/4.8-fixes' into docs-nextJonathan Corbet2016-08-141-1/+2
| |\ \ \
| | * | | doc-rst: customize RTD theme, drop padding of inline literalMarkus Heiser2016-08-141-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Remove the distracting (left/right) padding of inline literals. (HTML <code>). Requested and discussed in [1]. [1] http://www.spinics.net/lists/linux-media/msg103991.html Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | | | Merge branch 'doc/4.8-fixes' into docs-nextJonathan Corbet2016-08-132-7/+1Star
| |\| | | | | |/ / | |/| |
| | * | docs: kernel-documentation: remove some highlight directivesJonathan Corbet2016-08-121-6/+0Star
| | | | | | | | | | | | | | | | | | | | | | | | With the conf.py change, we don't need them to avoid warnings anymore. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| | * | docs: Set the Sphinx default highlight language to "guess"Jonathan Corbet2016-08-121-1/+1
| | |/ | | | | | | | | | | | | | | | | | | | | | This should eliminate a whole class of markup warnings, at the cost of occasionally amusing markup choices; we'll have to see if it works out. Suggested-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: exclude media documentation from pdf generationJani Nikula2016-08-121-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Although pdflatex is more robust than rst2pdf, building media documentation pdf still fails. Exclude media documentation from pdf generation for now. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Acked-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation: switch to pdflatex for pdf generationJani Nikula2016-08-121-7/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Looks like rst2pdf is not robust enough, especially for large documents. Use recursive make on the Sphinx generated makefile to convert latex to pdf. The ugly detail is that pdf is generated into Documentation/output/latex. Unfortunately, the pdflatex build generates huge amounts of build log noise, and also fails in the end. We'll fix that next. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Acked-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * | Documentation/sphinx: build the media intermediate rst files for all outputsJani Nikula2016-08-122-3/+3
| |/ | | | | | | | | | | | | | | | | This is a stopgap measure to allow building outputs other than html. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Acked-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | [media] MAINTAINERS: atmel-isc: add entry for Atmel ISCSongjun Wu2016-08-221-0/+8
| | | | | | | | | | | | | | | | | | Add the MAINTAINERS' entry for Microchip / Atmel Image Sensor Controller. Signed-off-by: Songjun Wu <songjun.wu@microchip.com> Acked-by: Nicolas Ferre <nicolas.ferre@atmel.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] atmel-isc: DT binding for Image Sensor Controller driverSongjun Wu2016-08-221-0/+65
| | | | | | | | | | | | | | | | | | DT binding documentation for ISC driver. Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Songjun Wu <songjun.wu@microchip.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] atmel-isc: add the Image Sensor Controller codeSongjun Wu2016-08-226-0/+1692
| | | | | | | | | | | | | | | | | | | | | | | | Add driver for the Image Sensor Controller. It manages incoming data from a parallel based CMOS/CCD sensor. It has an internal image processor, also integrates a triple channel direct memory access controller master interface. Signed-off-by: Songjun Wu <songjun.wu@microchip.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: fix some .. note:: occurrencesMauro Carvalho Chehab2016-08-225-5/+5
| | | | | | | | | | | | | | | | On some places, either an space or the second ':' is missing. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: fix some LaTeX errors when in interactive modeMauro Carvalho Chehab2016-08-227-11/+10Star
| | | | | | | | | | | | | | | | | | There are several minor issues that are seen when building PDF on interactive mode. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: v4l2-drivers book: adjust column marginsMauro Carvalho Chehab2016-08-222-54/+65
| | | | | | | | | | | | | | | | A few tables are not properly output on LaTeX format. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] v4l2-dev.rst: adjust table to fit into pageMauro Carvalho Chehab2016-08-221-0/+1
| | | | | | | | | | | | | | One table here is not being properly displayed on LaTeX format. Adjust it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] cec-ioc-receive.rst: one table here should be longtableMauro Carvalho Chehab2016-08-221-0/+2
| | | | | | | | | | | | The table is too big to fit into a single page on LaTeX format. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] subdev-formats.rst: adjust tables size for LaTeX outputMauro Carvalho Chehab2016-08-221-6/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | There are two big tables here that are very hard to adjust its size. The first one would fit into one page, but the latex.py logic at Sphinx auto-switches to longtable when there are more than 30 rows. There's no way to override without coding. The second one is really big, and won't fit on a single page. So, it has to use tiny font to fit. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] extended-controls.rst: avoid going past page with LaTeXMauro Carvalho Chehab2016-08-221-54/+213
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It is painful to put code/verbatim code in bold. It seems that the only way is to arrange it like: ``foo`` bar At least on LaTeX output, when this happens, the "foo" string is not hidentable/breakable. The entire string should fit into a single line. Add a workaround for this ReST limitation by splitting the foo string into two strings, on separate lines. The output is not the best, but it works. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] Fix a few additional tables at uAPI for LaTeX outputMauro Carvalho Chehab2016-08-225-7/+6Star
| | | | | | | | | | | | | | There are still a few tables with wrong columns at the uAPI docs. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: fix warnings introduced by LaTeX patchsetMauro Carvalho Chehab2016-08-2240-222/+186Star
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx is really pedantic with respect to the order where table tags and references are created. Putting things at the wrong order causes troubles. The order that seems to work is: .. raw:: latex .. tabularcolumns:: .. _foo_name: .. cssclass: longtable .. flat-table:: Reorder the tags to the above order, to avoid troubles, and fix remaining warnings introduced by media recent patches. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] gen-errors.rst fix error table column limitsMauro Carvalho Chehab2016-08-221-1/+1
| | | | | | | | | | | | | | Fix the generic errors table to avoid column overflows on LaTeX output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] uapi/cec: adjust tables on LaTeX outputMauro Carvalho Chehab2016-08-225-24/+21Star
| | | | | | | | | | | | Fix tables to avoid text to overflow the cell limits. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] cec-core: Convert it to ReST formatMauro Carvalho Chehab2016-08-221-53/+94
| | | | | | | | | | | | | | | | There are some things there that aren't ok for ReST format. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: move cec kAPI documentation to the media bookMauro Carvalho Chehab2016-08-222-0/+1
| | | | | | | | | | | | The CEC kAPI documentation should also be part of the media book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] media-types.rst: adjust tables to fit on LaTeX outputMauro Carvalho Chehab2016-08-221-2/+12
| | | | | | | | | | | | | | A few tables at the media uAPI documentation have columns not well dimentioned. Adjust them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] adjust remaining tables at DVB uAPI documentationMauro Carvalho Chehab2016-08-2210-3/+15
| | | | | | | | | | | | | | There are a few broken tables on LaTeX output at the DVB uAPI documentation. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] fe_property_parameters.rst: Adjust column sizesMauro Carvalho Chehab2016-08-221-0/+3
| | | | | | | | | | | | | | Add position hints for some tables, in order for them to be shown properly on LaTeX output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] fix v4l2-selection-*.rst tables for LaTeX outputMauro Carvalho Chehab2016-08-222-0/+3
| | | | | | | | | | | | Adjust the tables there to fit inside the page margins. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-g-tuner.rst: Fix tables to fit at LaTeX outputMauro Carvalho Chehab2016-08-221-8/+24
| | | | | | | | | | | | | | Several tables are missing column definitions and/or are too big to fit into the page. Adjust them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-g-tuner.rst: improve documentation for tuner typeMauro Carvalho Chehab2016-08-221-6/+6
| | | | | | | | | | | | | | | | | | The tuner type table misses descriptions for each type. While most of stuff are obvious, the two SDR definitions aren't. So, add descriptions to all of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] adjust some vidioc-*rst tables with wrong columnsMauro Carvalho Chehab2016-08-2213-30/+50
| | | | | | | | | | | | | | Adjust simple cases where the columns on some vidioc files are overriding their neighbours. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-g-sliced-vbi-cap.rst: make tables fit on LaTeX outputMauro Carvalho Chehab2016-08-221-7/+23
| | | | | | | | | | | | | | | | | | | | | | The tables don't fit at the page on this file. As noticed before, Sphinx (or LaTeX?) does a crap job on tables with cell span, and some work has to be done to make it fit. Move the see also reference to a footnote, break one paragraph into two and adjust the table columns to make it visible. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-enumstd.rst: adjust video standards tableMauro Carvalho Chehab2016-08-221-4/+19
| | | | | | | | | | | | | | | | | | | | | | | | This table is too big for LaTeX output, and lacks columns specs for LaTeX format. Also, it has a hidden column, as there are some cell spans with the wrong values. Fix it, so it can be displayed properly on LaTeX/PDF. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-dv-timings-cap.rst: Adjust LaTeX columnsMauro Carvalho Chehab2016-08-221-6/+8
| | | | | | | | | | | | Some tables are not properly displayed on LaTeX. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-dqevent.rst: adjust two table columns for LaTeX outputMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | | | | | | | There are two tables with mangled columns. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] vidioc-decoder-cmd.rst: better adjust column widthsMauro Carvalho Chehab2016-08-221-4/+6
| | | | | | | | | | | | Better adjust the columns for LaTeX output Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] diff-v4l.rst: Make capabilities table fit in LaTeXMauro Carvalho Chehab2016-08-221-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This table has several troubles: - a duplicated "struct" on its name; - a reference to a V4L version 1 struct that will never point to something (as we got rid of V4L1 API a long time ago); - misses hints for LaTeX output (column size and longtable style). Fix them. It should be noticed that the first column of this table is not aligned with the rest. I suspect that this is a bug at the flat-table extension. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] subdev-formats.rst: adjust most of the tables to fill in pageMauro Carvalho Chehab2016-08-221-2769/+2806
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix mosto fo the tables there in order to make them fit at the page size. There are, however, two exceptions: RGB and YUV big tables, where adding the raw latex adjustbox caused the tables to not be properly formatted. I suspect that the problem is because those are long tables, but not really sure. The thing is that Sphinx lacks an "adjustbox" tag that would avoid the raw latex hacks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-subdev.rst: make table fully visible on LaTeXMauro Carvalho Chehab2016-08-221-0/+9
| | | | | | | | | | | | | | | | | | The table there is too big and doesn't have format hints for LaTeX output. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-rds.rst: adjust table dimentions for LaTeXMauro Carvalho Chehab2016-08-221-1/+1
| | | | | | | | | | | | One of the tables has wrong column dimentions. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-sliced-vbi.rst: Adjust tables on LaTeX outputMauro Carvalho Chehab2016-08-221-10/+24
| | | | | | | | | | | | | | Better format the tables in a way that will fit inside the page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-sliced-vbi.rst: use a footnote for VBI imagesMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | | | | | | | | | | | Just like on dvb-raw-vbi.rst, the LaTeX output doesn't work well with cell spans. Also, this is actually a note, so, move it to a footnote. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] docs-rst: re-generate vbi_525.pdf and vbi_625.pdfMauro Carvalho Chehab2016-08-222-0/+0
| | | | | | | | | | | | | | | | Originally, each image were one page big, causing them to be displayed on separate pages at the PDF output. Re-generate them from the gif files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-raw-vbi.rst: adjust table columns for LaTeX outputMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | | | | | | | Add the needed tags to fix LaTeX output of the tables there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-raw-vbi.rst: add a footnote for the count limitsMauro Carvalho Chehab2016-08-221-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | There's a bug with LaTeX output on flat-tables with Sphinx 1.4.5 that prevents references at a cell span to be broken. As the text is indeed too long, it makes sense to place the reference to the pictures showing the VBI limits as a footnote. That makes the text easier to read and also solves the issue with LaTeX output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* | [media] dev-overlay.rst: don't ident a noteMauro Carvalho Chehab2016-08-221-5/+5
| | | | | | | | | | | | | | There's one note there that it is indented for no good reason. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3-55-g7522 (git 2.39.0) at 2024-07-13 11:38:16 +0200