Commit Graph

20 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
bb27da1d3f doc-rst: control: Fix missing reference for example 8
The conversion broke references and captions for examples.

Fix the missing reference for control enumeration.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:14 -03:00
Mauro Carvalho Chehab
63ea6309f4 doc-rst: control: read the example captions
Those got removed by the doc conversion.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:14 -03:00
Mauro Carvalho Chehab
09e6b3267a doc-rst: linux_tv: remove controls
This auto-generated file is bogus: it just adds a toc for two
other files. Instead, just move the controls and extended-controls
directly to the common file.

this avoids a blank page, and better organize the document.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:13 -03:00
Mauro Carvalho Chehab
f243762fed doc-rst: standard: read the example captions
Those got lost during format conversion.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:12 -03:00
Mauro Carvalho Chehab
8f41704025 doc-rst: audio: re-add captions for the examples
The captions were lost during the format conversion.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:12 -03:00
Mauro Carvalho Chehab
4e03cb760d doc-rst: linux_tv: don't simplify VIDIOC_G_foo references
As VIDIOC_G_foo is the reference used for VIDIOC_S_foo and
VIDIOC_TRY_foo, we need to explicitly name the reference, as
otherwise, it will mention the three ioctls altogether, with
is not what we want.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:11 -03:00
Mauro Carvalho Chehab
2212ff259f doc-rst: linux_tv: convert lots of consts to references
There were lots of consts at the media docbook that should
be, instead, references. Convert the ones that can easily
be done by an automatic script.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:54:30 -03:00
Mauro Carvalho Chehab
7347081e8a doc-rst: linux_tv: simplify references
There are lots of internal references in the form:
	:ref:`foo <foo>`

Simplify them to be just: :ref:`foo`.

Patch generated via this small script:

for j in $(find . -name '*'); do echo $j; perl -ne 'if (m/\`(\S+)\s*\<(\S+)\>\`/) { if (!($1=~'http') && $1 eq $2) { s,\s*\<(\S+)\>,,; } } print $_' <$j >a && mv a $j; done

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:54:22 -03:00
Mauro Carvalho Chehab
af4a4d0db8 doc-rst: linux_tv: Replace reference names to match ioctls
Due to a limitation at the DocBook language, the references
were using lowercase and slashes, instead of the name of the
ioctls. On ReST, make them identical. This will hopefully
help to cleanup the code a little bit.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:54:10 -03:00
Mauro Carvalho Chehab
7898188452 doc-rst: audio: Fix some cross references
There are several constants there that should be, instead,
cross-references. Fix them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:54:02 -03:00
Mauro Carvalho Chehab
013504f537 doc-rst: video: Restore the captions for the examples
There are two examples in the code, but the captions of them
were lost during the ReST conversion. Manually add them again.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:53:47 -03:00
Mauro Carvalho Chehab
c7685f2797 doc-rst: v4l2: numerate the V4L2 chapters
The Video4Linux documentation is big. We want to numerate the
items, as it makes easier to reference an item while discussing
the document on meetings.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:53:38 -03:00
Mauro Carvalho Chehab
234d549662 doc-rst: video: use reference for VIDIOC_ENUMINPUT
Instead of using const, transform it into a reference.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:53:31 -03:00
Mauro Carvalho Chehab
e6702ee18e doc-rst: app-pri: Fix a bad reference
What should be a reference to VIDIOC_S_PRIORITY was incorrectly
defined as a constant at the DocBook. Fix it on the rst version.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:53:21 -03:00
Mauro Carvalho Chehab
766e137d05 doc-rst: linux_tv/index: add xrefs for document divisions
Make easier to navigate at the media document by adding the
links to each of the parts of the document.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:52:49 -03:00
Mauro Carvalho Chehab
9e00ffca8c doc-rst: querycap: fix troubles on some references
This is not due to the format change, but there are some
wrong references on this file. Fix them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:52:42 -03:00
Mauro Carvalho Chehab
080df77f00 doc-rst: v4l2: Fix authors and revisions lists
The conversion of the authors and revision history lists
didn't end too well.

Manually fix them.

The revision history still needs some care in the future.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:52:31 -03:00
Mauro Carvalho Chehab
72f5a661c6 doc-rst: some fixups at linux_tv/index
Fix some issues from the conversion and improve the documentation
a little bit, by adding two relevent keywords (SDR and DTMB).

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-01 14:52:17 -03:00
Mauro Carvalho Chehab
40f7bc9b1f doc-rst: linuxt_tv: update the documentation year
The RST version was produced in 2016. So, update it where
it was still pointing to the wrong year.

While here, added the missing (copyright) symbols.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 16:45:17 -03:00
Markus Heiser
5377d91f3e doc-rst: linux_tv DocBook to reST migration (docs-next)
This is the restructuredText (reST) migration of the ``media``
DocBook-XML set from the linux_tv project.

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 16:14:52 -03:00