25744 Commits

Author SHA1 Message Date
7f1bd7cdf6 doc-rst: pixfmt-007: Fix formula parsing
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>
2016-07-03 17:47:35 -03:00
ac4141ce74 doc-rst: linux_tv: Fix remaining undefined references
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>
2016-07-03 13:51:40 -03:00
acf309a2d5 doc-rst: linux_tv: use references for structures
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>
2016-07-03 13:40:22 -03:00
cdb4af0fd5 doc-rst: linux_tv: Error codes should be const
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>
2016-07-03 12:06:32 -03:00
dd96815f42 doc-rst: selection-api-006: add missing captions
The example captions got stripped by the conversion to ReST.
Re-add.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 11:33:18 -03:00
da1621c300 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 11:24:58 -03:00
8e97cd9431 doc-rst: selection-api-005: Fix ReST parsing
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>
2016-07-03 11:17:12 -03:00
cdaa78fe92 doc-rst: crop: fix conversion on this file
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>
2016-07-03 11:09:26 -03:00
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
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
90ffc75f56 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.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-03 10:05:15 -03:00
22c1cd2d79 doc-rst: extended-controls: use reference for VIDIOC_S_CTRL
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>
2016-07-03 10:05:15 -03:00
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
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
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
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
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
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
a039ba34a3 Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt
This patch fix some spelling typo found in ocfs2-online-filecheck.txt

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-07-01 16:17:15 -06:00
6387872c86 Documentation/sphinx: skip build if user requested specific DOCBOOKS
If the user requested specific DocBooks to be built using 'make
DOCBOOKS=foo.xml htmldocs', assume no Sphinx build is desired. This
check is transitional, and can be removed once we drop the DocBook
build.

Cc: Markus Heiser <markus.heiser@darmarit.de>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx configuration and build")
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-07-01 16:16:07 -06:00
a569bf69f0 Documentation: add cleanmediadocs to the documentation targets
This was broken when updating the documentation targets for the Sphinx
build, and moving from %docs target pattern to explicitly listed
targets.

Cc: Markus Heiser <markus.heiser@darmarit.de>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx configuration and build")
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-07-01 16:15:31 -06:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
6ab99fa6a0 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
  ...
2016-06-30 16:10:47 -03:00
19abdb15f3 Add .pyc files to .gitignore
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-30 13:07:33 -06:00
05d0066a57 Doc: PM: Fix a typo in intel_powerclamp.txt
This patch fix a spelling typo in intel_powerclamp.txt

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-30 13:05:40 -06:00
0249a76448 doc-rst: flat-table directive - initial implementation
Implements the reST flat-table directive.

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]

[1] https://github.com/return42/sphkerneldoc/commits/master/scripts/site-python/linuxdoc/rstFlatTable.py

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>
2016-06-30 12:58:33 -06:00
c7169ad561 [media] DocBook/media: add CEC documentation
Add DocBook documentation for the CEC API.

Signed-off-by: Hans Verkuil <hansverk@cisco.com>
[k.debski@samsung.com: add documentation for passthrough mode]
[k.debski@samsung.com: minor fixes and change of reserved field sizes]
Signed-off-by: Kamil Debski <kamil@wypas.org>
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-28 11:45:24 -03:00
6f8adea2b6 [media] vivid: add CEC emulation
The vivid driver has been extended to provide CEC adapters for the HDMI
input and HDMI outputs in order to test CEC applications.

This CEC emulation is faithful to the CEC timings (i.e., it all at a
snail's pace).

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-28 11:31:16 -03:00
1bcbf6f4b6 [media] cec: s5p-cec: Add s5p-cec driver
Add CEC interface driver present in the Samsung Exynos range of
SoCs.

The following files were based on work by SangPil Moon:
- exynos_hdmi_cec.h
- exynos_hdmi_cecctl.c

Signed-off-by: Kamil Debski <kamil@wypas.org>
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-28 11:30:18 -03:00
17defc282f Documentation: add meta-documentation for Sphinx and kernel-doc
Describe Sphinx, reStructuredText, the kernel-doc extension, the
kernel-doc structured documentation comments, etc.

The kernel-doc parts are based on kernel-doc-nano-HOWTO.txt, by Tim
<twaugh@redhat.com>.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-24 06:55:28 -06:00
072baa0371 Documentation: tiny typo fix in usb/gadget_multi.txt
Signed-off-by: Michal Nazarewicz <mina86@mina86.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-23 08:09:10 -06:00
a37376f326 Documentation: fix wrong value in md.txt
In the current Documentation/md.txt, the lower limit value of
stripe_cache_size is 16 and the default value is 128, but when
I update kernel to the latest mainline version and RAID5 array
is created by mdadm, then execute the following commands, it
shows an error and a difference respectively.

1) set stripe_cache_size to 16
[root@localhost ~]# echo 16 > /sys/block/md0/md/stripe_cache_size
bash: echo: write error: Invalid argument
2) read the default value of stripe_cache_size
[root@localhost ~]# cat /sys/block/md0/md/stripe_cache_size
256

I read drivers/md/raid5.c and find the following related code:
1) in function 'raid5_set_cache_size':
if (size <= 16 || size > 32768)
	return -EINVAL;
2) #define NR_STRIPES		256

So the lower limit value of stripe_cache_size should be 17 and
the default value should be 256.

Signed-off-by: Tiezhu Yang <kernelpatch@126.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-23 08:08:36 -06:00
c0b8c9a344 bcache: documentation formatting, edited for clarity, stripe alignment notes
Signed-off-by: Eric Wheeler <bcache@linux.ewheeler.net>
Cc: Marc MERLIN <marc@merlins.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-23 07:58:38 -06:00
c9b2ffc022 bcache: documentation updates and corrections
Bcache documentation updates:
- Added new HOWTO/COOKBOOK section
- fixed a few typos
- /sys/block/bcache0/cache_mode is /sys/block/bcache0/bcache/cache_mode

Signed-off-by: Marc MERLIN <marc@merlins.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-06-23 07:57:03 -06:00
ebc88ef05c Documentation: add top level 'make help' output for Sphinx
While there's slight overlap with the DocBook help now, this can stay
intact when the DocBook help goes away.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-06-23 15:11:51 +03:00
0cea220cf7 Documentation/sphinx: drop modindex, we don't have python modules
The modindex is for python modules.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-06-23 15:11:35 +03:00
efe2938dd6 [media] cec.txt: add CEC framework documentation
Document the new HDMI CEC framework.

[k.debski@samsung.com: add DocBook documentation by Hans Verkuil, with

Signed-off-by: Kamil Debski <kamil@wypas.org>
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-22 08:36:50 -03:00