There are several broken references there, due to the conversion to
C domain. Fix them using this shell script and manually adjust what's
broken:

	# funcs is a file with the broken functions/references
	for i in $(cat funcs|sort|uniq|perl -ne 'print "$1\n" if (m/(\S+)$/)'); do
		i=${i//-/_}
		echo $i
		j=${i//_/-}
		for k in $(git grep -l "_$j:" Documentation/); do
			sed s,\_$j\:,"c\:type\:\: $i", <$k >a && mv a $k
		done
		for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
			sed s,$j,":c\:type\:\`$i\`", <$k >a && mv a $k
		done
		for k in $(git grep -l "$j" Documentation/); do
			sed "s,:ref:\`$i <$j>\`,:c:type:\`$i\`," <$k >a && mv a $k
			sed "s,:ref:\`$j\`,:c:type:\`$i\`," <$k >a && mv a $k
			sed -E "s,:ref:\`(.*)<$j>\`,:c:type:\`\1<$i>\`," <$k >a && mv a $k
		done
		for k in $(git grep -l "<$j>" include/media); do
			sed -E "s,:ref:\`(.*)<$j>\`,enum \&$i," <$k >a && mv a $k
		done
	done
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Several structs were renamed or removed during V4L2 development.
Don't try to cross-reference the legacy ones.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Use C cross-references to mention the V4L2 API calls on all
places it occurs inside this file.

While here, also mark constants as such.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

c:type is not the right tag for function definitions.
Replace them by .. c:function::
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix those warnings:

	Documentation/media/uapi/cec/cec-ioc-dqevent.rst:124: WARNING: c:func reference target not found: clock_gettime(2)

By replacing it with the right function name, using this shell script:

	for i in `find Documentation/media -type f`; do sed 's,clock_gettime(2),clock_gettime,' <$i >a && mv a $i; done

Please notice that this will make the nitpick mode to shut up
complaining about that, becasue clock_gettime is on its exclude list,
but the cross reference will be undefined until someone documents
this function at the core documentation.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The :c:type: references point to the structure name, and not to
struct foo.

Fixed via this shell script:

	for i in `find Documentation/media -type f`; do perl -ne 'if (s/\:c\:type\:\`struct\s*(\S+)\`/struct :c:type:`$1`/) { s/struct\s+struct/struct/;  s/(struct\s+\:c\:type\:\`\S+\`)\s+structure/$1/;  } print $_' <$i >a && mv a $i; done
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of using c:type:`struct foo <foo>`, use:
	struct c:type:`foo`

This patch was generated via this shell script:

	for i in `find Documentation/media -type f`; do perl -ne 'if (m/\:c\:type\:\`struct\s+(\S+)\s*\<(\S+)\>\`/) { $s=$1; $r=$2; if ($s eq $r) { s/\:c\:type\:\`struct\s+(\S+)\s*\<(\S+)\>\`/struct :c:type:`$2`/; s/struct\s+struct/struct/;  s/(struct\s+\:c\:type\:\`\S+\`)\s+structure/$1/;  }} print $_' <$i >a && mv a $i; done
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Fix some CEC cross references that are broken.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Some structs are pointed via the typedef. As we replaced
those references, fix them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Trivially fix those broken references, by copying the structs
fron the header, just like other API documentation at the
DVB side.

This doesn't have the level of quality used at the V4L2 side
of the API, but, as this documents a deprecated API, used
only by av7110 driver, it doesn't make much sense to invest
time making it better.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Several links are broken, as they were using the typedef
name, instead of using the corresponding structs. Fix them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Add a table describing the fields on this struct, based
on ca.h header.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Add documentation for struct ca_slot_info and for the two
sets of define used by it, according with what's there at the
ca.h header.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are no descriptions at ca.h header for this struct.
Yet, as we want to get rid of the warnings, let's add a
boilerplate, with just the struct types and fields.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The documentation follows what's there at the ca.h header.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Add a flat-table describing struct ca_caps, as found at
the source file.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are two warnings that are due to functions that has long
gone:

	Documentation/media/kapi/v4l2-subdev.rst:417: WARNING: c:func reference target not found: v4l2_i2c_new_subdev_cfg
	Documentation/media/kapi/v4l2-subdev.rst:436: WARNING: c:func reference target not found: v4l2_i2c_new_probed_subdev

Update the documentation to remove those.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The "struct" were inside the reference, causing it to break.
Acked-by: NLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are several undocumented functions here; document them.

While here, make checkpatch.pl happy.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_state_change
Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_state_change
Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_lost_msgs
Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_lost_msgs
Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_state_change
Documentation/output/cec.h.rst:6: WARNING: c:type reference target not found: cec_event_lost_msgs
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Change the parse-headers.pl and the corresponding files to use
the C domain for enum references.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The V4L version 1 structures had long gone from the Linux Kernel.
It doesn't make sense to use cross-references for them, as they
won't be found.

So, get rid of them.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

instead of declaring the uAPI structs using usual refs, e. g.:
	.. _foo-struct:

Use the C domain way:
	.. c:type:: foo_struct

This way, the kAPI documentation can use cross-references to
point to the uAPI symbols.

That solves about ~100 undefined warnings like:
	WARNING: c:type reference target not found: foo_struct
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There are some functions/macros used by the mediactl documentation
that are alien to the media subsystem. Ignore them.

After this patch, the media core will only complain about this
static function:
	Documentation/media/kapi/mc-core.rst:97: WARNING: c:func reference target not found: media_devnode_release
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

The cross-reference to "struct media_pad" was pointing to
a place that doesn't exist. Fix it, and adjust the second
reference on the same paragraph to use the same text.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of keeping those notes at the file on a non-structured
way, move them to dtv-core.rst, using the proper ReST tags.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

There a some other types and functions that aren't declared
inside the media document but are elsewhere. Add them to the
ignore list.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Instead of keep using the normal reference, move to the C
domain ones. Using C domains everywhere will allow
cross-references between kAPI and uAPI docs.
Acked-by: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Add a parser for the --debug option, in order to allow
seeing what the parser is doing.
Acked-by: NJonathan Corbet <corbet@lwn.net>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This patch adds DT binding documentation for STMicroelectronics hva
driver.
Signed-off-by: NYannick Fertre <yannick.fertre@st.com>
Signed-off-by: NJean-Christophe Trotin <jean-christophe.trotin@st.com>
Acked-by: NPeter Griffin <peter.griffin@linaro.org>
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

To build only the PDF of the media folder run::

  make SPHINXDIRS=media pdfdocs
Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

This extends the method to build only sub-folders to the targets
"latexdocs" and "pdfdocs". To do so, a conf.py in the sub-folder is
required, where the latex_documents of the sub-folder are
defined. E.g. to build only gpu's PDF add the following to the
Documentation/gpu/conf.py::

  +latex_documents = [
  +    ("index", "gpu.tex", "Linux GPU Driver Developer's Guide",
  +     "The kernel development community", "manual"),
  +]

and run:

  make SPHINXDIRS=gpu pdfdocs
Signed-off-by: NMarkus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

The setup() function of a Sphinx-extension can return a dictionary. This
is treated by Sphinx as metadata of the extension [1].

With metadata "parallel_read_safe = True" a extension is marked as
save for "parallel reading of source". This is needed if you want
build in parallel with N processes. E.g.:

  make SPHINXOPTS=-j4 htmldocs

will no longer log warnings like:

  WARNING: the foobar extension does not declare if it is safe for
  parallel reading, assuming it isn't - please ask the extension author
  to check and make it explicit.

Add metadata to extensions:

* kernel-doc
* flat-table
* kernel-include

[1] http://www.sphinx-doc.org/en/stable/extdev/#extension-metadataSigned-off-by: NMarkus Heiser <markus.heiser@darmarIT.de>
Tested-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

From the old description people still can't get what's the exact
difference between nr_cpus and maxcpus. Especially in kdump kernel
nr_cpus is always suggested if it's implemented in the ARCH. The
reason is nr_cpus is used to limit the max number of possible cpu
in system, the sum of already plugged cpus and hot plug cpus can't
exceed its value. However maxcpus is used to limit how many cpus
are allowed to be brought up during bootup.
Signed-off-by: NBaoquan He <bhe@redhat.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Fix copy-and-paste error: the radio devices are /dev/radio, not /dev/vbi.
Signed-off-by: NHans Verkuil <&lt;hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Add support for the Hauppauge WinTV quadHD ATSC version.
IR support has not been provided, all 4 tuners, demodulators etc are working.
Further documentation can be found on Linux TV wiki.
Signed-off-by: NStephen Backway <stev391@gmail.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

/devel/v4l/patchwork/Documentation/media/uapi/v4l/extended-controls.rst:2116: WARNING: Inline literal start-string without end-string.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

This field was never documented, and neither was it mentioned that
it should be zeroed by the application.
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

V4L2_CTRL_FLAG_VOLATILE behaviour when V4L2_CTRL_FLAG_EXECUTE_ON_WRITE
is set was not properly explained.

Also set some hyperlink to ease the Documentation browsing.

Credit-to: Hans Verkuil <hansverk@cisco.com>

[mchehab@s-opensource.com: fix a trivial merge conflict]
Reported-by: NDimitrios Katsaros <patcherwork@gmail.com>
Signed-off-by: NRicardo Ribalda Delgado <ricardo.ribalda@gmail.com>
Signed-off-by: NHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>