linux.git/Documentation/media/uapi/dvb, branch v4.9

[media] docs-rst: simplify c:type: cross references

2016-09-09T12:54:54+00:00

Instead of using c:type:`struct 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: Mauro Carvalho Chehab

[media] docs-rst: fix dmx bad cross-references

2016-09-09T12:53:54+00:00

Some structs are pointed via the typedef. As we replaced
those references, fix them.

Signed-off-by: Mauro Carvalho Chehab

[media] fix broken references on dvb/video*rst

2016-09-09T12:53:35+00:00

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: Mauro Carvalho Chehab

[media] docs-rst: fix the remaining broken links for DVB CA API

2016-09-09T12:52:50+00:00

Several links are broken, as they were using the typedef
name, instead of using the corresponding structs. Fix them.

Signed-off-by: Mauro Carvalho Chehab

[media] ca-set-pid.rst: document struct ca_pid

2016-09-09T12:52:16+00:00

Add a table describing the fields on this struct, based
on ca.h header.

Signed-off-by: Mauro Carvalho Chehab

[media] ca-get-slot-info.rst: document struct ca_slot_info

2016-09-09T12:51:09+00:00

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: Mauro Carvalho Chehab

[media] ca-get-msg.rst: add a boilerplate for struct ca_msg

2016-09-09T12:49:34+00:00

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: Mauro Carvalho Chehab

[media] ca-get-descr-info.rst: add doc for for struct ca_descr_info

2016-09-09T12:48:58+00:00

The documentation follows what's there at the ca.h header.

Signed-off-by: Mauro Carvalho Chehab

[media] ca-get-cap.rst: add a table for struct ca_caps

2016-09-09T12:45:45+00:00

Add a flat-table describing struct ca_caps, as found at
the source file.

Signed-off-by: Mauro Carvalho Chehab

[media] docs-rst exceptions: use C domain references for DVB headers

2016-09-09T12:45:24+00:00

Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.

Signed-off-by: Mauro Carvalho Chehab