Commit Graph

6 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
b7e67f6c1b doc-rst: linux_tv: supress lots of warnings
The c language parser checks if there are duplicated object
definitions. That causes lots of warnings like:
	WARNING: duplicate C object description of ioctl

Let's remove those by telling Sphinx that the language for
those objects are c++. The look of the descriptions will
be close, and the warnings will be gone.

Please notice that we had to keep a few of them as C, as
the c++ parser seems to be broken when it finds an enum.

Yet, this reduced from 219 warnings to 143, with is
a good thing.

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