Sphinx actually doesn't numerate tables nor figures. So,
let's add a subtitle before each table. That makes them
"numerated".
While here, fix the git binary that got corrupted.
Let's hope this will work, as the reason why we had
to encode them were to prevent some issues on commiting
those gif files on git.
Originally, at the DocBook, the "Byte Order" were a single
paragraph with the string that follows it. The conversion
broke it, and, sometimes, it added an extra dot.
doc-rst: linux_tv: promote generic documents to the parent dir
The generic error codes and licensing sections are general to the
entire media book. They should not be inside the v4l dir. So,
promote them to the parent directory.
Using auto-generated links is dangerous, as there are multiple
definitions for syscalls (at least one on each book part).
So, reference them by their explicit reference.
I used this small script to help writing this patch:
for i in $(git grep -l "c:func:"); do perl -ne 's/\:c\:func:\`(open|close|read|poll|write|select|mmap|munmap|ioctl)\(\)`/:ref:`$1() <func-$1>`/; print $_' < $i >a && mv a $i; done
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.
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.
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.
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.
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$
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.
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.
doc-rst: linux_tv: use Example x.y. instead of a single number
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.
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.
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.
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.
doc-rst: vidioc-queryctl: change the title of this chapter
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.
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.
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.
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.
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.
Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next
* 'docs-next' of git://git.lwn.net/linux: (64 commits)
Add .pyc files to .gitignore
Doc: PM: Fix a typo in intel_powerclamp.txt
doc-rst: flat-table directive - initial implementation
Documentation: add meta-documentation for Sphinx and kernel-doc
Documentation: tiny typo fix in usb/gadget_multi.txt
Documentation: fix wrong value in md.txt
bcache: documentation formatting, edited for clarity, stripe alignment notes
bcache: documentation updates and corrections
Documentation: add top level 'make help' output for Sphinx
Documentation/sphinx: drop modindex, we don't have python modules
Documentation/sphinx: add support for specifying extra export files
Documentation/sphinx: use a more sensible string split in kernel-doc extension
Documentation/sphinx: remove unnecessary temporary variable
kernel-doc: unify all EXPORT_SYMBOL scanning to one place
kernel-doc: add support for specifying extra files for EXPORT_SYMBOLs
kernel-doc: abstract filename mapping
kernel-doc: add missing semi-colons in option parsing
kernel-doc: do not warn about duplicate default section names
kernel-doc: remove old debug cruft from dump_section()
docs: kernel-doc: Add "example" and "note" to the magic section types
...
The ``flat-table`` is a double-stage list similar to the ``list-table`` with
some additional features:
* column-span: with the role ``cspan`` a cell can be extended through
additional columns
* row-span: with the role ``rspan`` a cell can be extended through
additional rows
* auto span rightmost cell of a table row over the missing cells on the right
side of that table-row. With Option ``:fill-cells:`` this behavior can
changed from *auto span* to *auto fill*, which automaticly inserts (empty)
list tables
The *list tables* formats are double stage lists. Compared to the
ASCII-art they migth be less comfortable for readers of the
text-files. Their advantage is, that they are easy to create/modify
and that the diff of a modification is much more meaningfull, because
it is limited to the modified content.
The initial implementation was taken from the sphkerneldoc project [1]
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
[jc: fixed typos and misspellings in the docs] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Laurent Pinchart [Wed, 15 Jun 2016 23:27:58 +0000 (20:27 -0300)]
[media] videodev2.h: Group YUV 3 planes formats together
The formats are interleaved with the YUV packed and miscellaneous
formats, making the result confusing especially with the YUV444 format
being packed and not planar like YUV410 or YUV420. Move them to their
own group as the 2 planes or 3 non-contiguous planes formats to clarify
the header.
Add detection of source pad number for drivers aware of the media controller
API, so that rcar-vin can create device nodes to support modern drivers such
as adv7604.c (for HDMI on Lager) and the converted adv7180.c (for composite)
underneath.
Building rcar_vin gains a dependency on CONFIG_MEDIA_CONTROLLER, in
line with requirements for building the drivers associated with it.
Signed-off-by: William Towle <william.towle@codethink.co.uk> Signed-off-by: Rob Taylor <rob.taylor@codethink.co.uk>
[ulrich.hecht+renesas@gmail.com: adapted to rcar-vin rewrite] Signed-off-by: Ulrich Hecht <ulrich.hecht+renesas@gmail.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Laurent Pinchart [Tue, 24 May 2016 11:53:39 +0000 (08:53 -0300)]
[media] adv7604: Don't ignore pad number in subdev DV timings pad operations
The dv_timings_cap() and enum_dv_timings() pad operations take a pad
number as an input argument and return the DV timings capabilities and
list of supported DV timings for that pad.
Commit bd3e275f3ec0 ("[media] media: i2c: adv7604: Use v4l2-dv-timings
helpers") broke this as it started ignoring the pad number, always
returning the information associated with the currently selected input.
Fix it.
projects / linux-beck.git / log