- 03 Jul, 2016 27 commits
-
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
One paragraph mentions the YUV422 formats, but doesn't provide a cross-ref. Add it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Constify the string "count" where it means a field. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Fix this Sphinx warning: Documentation/linux_tv/media/v4l/rw:31: WARNING: Literal block ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Fix those warnings: Documentation/linux_tv/media/v4l/open:38: WARNING: Literal block ends without a blank line; unexpected unindent. Documentation/linux_tv/media/v4l/open:45: WARNING: Literal block ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The ioctl is declared twice. This causes the following warning: /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/vidioc-g-edid:7: Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The asterisks cause parsing warnings with Sphinx: Documentation/linux_tv/media/dvb/fe_property_parameters:954: WARNING: Inline substitution_reference start-string without end-string. /devel/v4l/patchwork/Documentation/linux_tv/media/dvb/fe_property_parameters:993: WARNING: Inline emphasis start-string without end-string. On the first warning, the ISDB-T layer enabled description is a kind of ackward. Improve it. For the second one, IMHO, it is clearer to use [A-C], as it shows what are the real possibilities, than using asterisk. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Unescaped * causes warnings on Sphinx. Add an escape at hist-v4l2 occurrences. At libv4l-introduction, the best is do declare the function prototypes as C code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The conversion didn't add blank lines where needed, but it added were it weren't ;) Fix it, to make it to parse correctly by Sphinx. This also fixes a bunch or warnings: /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:44: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:52: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:58: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:71: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:78: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:84: WARNING: Explicit markup ends without a blank line; unexpected unindent. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/fdl-appendix:107: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
There are lots of warnings there: /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:74: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:89: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:168: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:183: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:206: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:216: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:292: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:308: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:393: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:478: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:657: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:735: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:746: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:822: ERROR: Unexpected indentation. /devel/v4l/patchwork/Documentation/linux_tv/media/v4l/pixfmt-007:833: ERROR: Unexpected indentation. Also, sometimes the :sup: tag was ignored. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Fix Sphinx those warnings: WARNING: undefined label: fdl-modified>`as given on the :ref:`title page <fdl-title-page (if the link has no caption the label must precede a section header) WARNING: undefined label: v4l2-pix-fmt-yuv420 (if the link has no caption the label must precede a section $ WARNING: undefined label: pixfmt-srggb10 (if the link has no caption the label must precede a section heade$ Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
On several places, instead of using references, the code was using some other tag. Not sure if this was due to the conversion, or if something were already wrong on the DocBook. In any case, let's fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
All error codes should be const. Most are, but there are lots of places where we forgot to add <constant> at the DocBook. Fix those via this small script: for i in $(git grep -lE "\s+E[A-Z]+\b" Documentation/linux_tv/); do perl -ne 's,([^\`])\b(E[A-Z]+)\b,\1``\2``,g; print $_' <$i >a && mv a $i; done As there are false positives, we needed to merge only the changes that make sense, skipping the c blocks and skipping things like EDID, EN, ETS that were also converted by the above code. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The example captions got stripped by the conversion to ReST. Re-add. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
On the example captions, use always <chapter>.<number>., because: 1) it matches the DocBook; 2) it would mean less changes if we need to add a new example, as only one chapter will be affected. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The ReST markup is limited: it doesn't accept a const just after a reference. So, change the documentation to avoid such constraint. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The conversion on this file didn't end too well. fix the found issues: 1) Sphinix seems to not allow things like *foo :ref:`bar`*. At least on this document, it did the wrong thing. So, change the logic to something that will work fine with ReST format; 2) Some ioctl pointers were not looking nice; 3) the captions on the examples got discarded; 4) The notes specific to each example were not converted well. Again, we'll need to replace it for a simpler design, as Sphinx is a way more limited than DocBook. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
This chapter is referenced on several parts of the extended controls. Change the title to make it nicer where it is referenced. Ok, we might, instead, just change the name for the references to only mention the oldest ioctl, but IMHO, it is better to keep the name of all ioctls where it is referenced. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
Instead of using a constant, use references, just like the other references for ioctl's. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
Those got removed by the doc conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
Those got lost during format conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
The captions were lost during the format conversion. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
- 01 Jul, 2016 12 commits
-
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
There are several constants there that should be, instead, cross-references. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
Instead of using const, transform it into a reference. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
Mauro Carvalho Chehab authored
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>
-
- 30 Jun, 2016 1 commit
-
-
Mauro Carvalho Chehab authored
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>
-