Commit Graph

6 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
64e4954619 doc-rst: linux_tv: remove trailing comments
The conversion script added some comments at the end.
They point to the original DocBook files, with will be
removed after the manual fixes. So, they'll be pointing
to nowere. So, remove those comments.

They'll be forever stored at the Kernel tree. So, if
someone wants the references, it is just a matter of
looking at the backlog.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 17:47:40 -03:00
Mauro Carvalho Chehab
c32940a682 doc-rst: planar-apis: fix some conversion troubles
There is a missing escape caracter, causing troubles at the
format of one of the paragraphs. Also, the ioctl description
was producing some warnings about wrong identation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:31:10 -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
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
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