12 Jan, 2017
1 commit
-
commit e2a91f4f42018994d7424d405900d17eba6555d0 upstream.
PDF build on Kernel 4.9-rc? returns an error with Sphinx 1.3.x
and Sphinx 1.4.x, when trying to solve some cross-references.The solution is to redefine the \DURole macro.
However, this is redefined too late. Move such redefinition to
LaTeX preamble and bind it to just the Sphinx versions where the
error is known to be present.Tested by building the documentation on interactive mode:
make PDFLATEX=xelatex -C Documentation/output/./latexFixes: e61a39baf74d ("[media] index.rst: Fix LaTeX error in interactive mode on Sphinx 1.4.x")
Signed-off-by: Mauro Carvalho Chehab
Signed-off-by: Jonathan Corbet
Signed-off-by: Greg Kroah-Hartman
06 Oct, 2016
1 commit
-
Linux 4.8
* tag 'v4.8': (1761 commits)
Linux 4.8
ARM: 8618/1: decompressor: reset ttbcr fields to use TTBR0 on ARMv7
MIPS: CM: Fix mips_cm_max_vp_width for non-MT kernels on MT systems
include/linux/property.h: fix typo/compile error
ocfs2: fix deadlock on mmapped page in ocfs2_write_begin_nolock()
mm: workingset: fix crash in shadow node shrinker caused by replace_page_cache_page()
MAINTAINERS: Switch to kernel.org email address for Javi Merino
x86/entry/64: Fix context tracking state warning when load_gs_index fails
x86/boot: Initialize FPU and X86_FEATURE_ALWAYS even if we don't have CPUID
x86/vdso: Fix building on big endian host
x86/boot: Fix another __read_cr4() case on 486
sctp: fix the issue sctp_diag uses lock_sock in rcu_read_lock
sctp: change to check peer prsctp_capable when using prsctp polices
sctp: remove prsctp_param from sctp_chunk
sctp: move sent_count to the memory hole in sctp_chunk
tg3: Avoid NULL pointer dereference in tg3_io_error_detected()
x86/init: Fix cr4_init_shadow() on CR4-less machines
MIPS: Fix detection of unsupported highmem with cache aliases
MIPS: Malta: Fix IOCU disable switch read for MIPS64
MIPS: Fix BUILD_ROLLBACK_PROLOGUE for microMIPS
...
22 Sep, 2016
3 commits
-
As warned by linuxdoc[1] tool, using:
$ for i in $(git grep kernel-doc Documentation/media/kapi/|cut -d: -f4); do kernel-lintdoc --sloppy $i; done
include/media/v4l2-dev.h:118 :WARN: function name from comment differs: v4l2_prio_close v4l2_prio_check
include/media/v4l2-mc.h:56 [kernel-doc WARN] : enum name from comment differs: if_vid_dec_index if_vid_dec_pad_index
include/media/v4l2-mc.h:71 [kernel-doc WARN] : enum name from comment differs: if_aud_dec_index if_aud_dec_pad_index
include/media/v4l2-mem2mem.h:396 [kernel-doc WARN] : function name from comment differs: v4l2_m2m_num_src_bufs_ready v4l2_m2m_num_dst_bufs_ready
drivers/media/dvb-core/dvb_math.h:28 [kernel-doc WARN] : function name from comment differs: cintlog2 intlog2
include/media/v4l2-subdev.h:215 [kernel-doc WARN] : struct name from comment differs: s_radio v4l2_subdev_tuner_ops
include/media/v4l2-subdev.h:890 [kernel-doc WARN] : function name from comment differs: v4l2_set_subdevdata v4l2_set_subdev_hostdata
include/media/v4l2-subdev.h:901 [kernel-doc WARN] : function name from comment differs: v4l2_get_subdevdata v4l2_get_subdev_hostdata
drivers/media/dvb-core/dvb_ringbuffer.h:196 [kernel-doc WARN] : function name from comment differs: dvb_ringbuffer_writeuser dvb_ringbuffer_write_user
include/media/videobuf2-core.h:399 [kernel-doc WARN] : struct name from comment differs: vb2_ops vb2_buf_ops
include/media/media-entity.h:132 [kernel-doc ERROR] : duplicate parameter definition 'source'
include/media/media-entity.h:477 [kernel-doc WARN] : function name from comment differs: media_entity_enum_test media_entity_enum_test_and_set
include/media/media-entity.h:535 [kernel-doc WARN] : function name from comment differs: gobj_to_entity gobj_to_pad
include/media/media-entity.h:544 [kernel-doc WARN] : function name from comment differs: gobj_to_entity gobj_to_link
include/media/media-entity.h:553 [kernel-doc WARN] : function name from comment differs: gobj_to_entity gobj_to_intf
include/media/media-entity.h:562 [kernel-doc WARN] : function name from comment differs: gobj_to_entity intf_to_devnode
include/media/rc-core.h:234 [kernel-doc WARN] : function name from comment differs: rc_open rc_close
include/media/v4l2-ctrls.h:397 [kernel-doc WARN] : missing initial short description of 'v4l2_ctrl_handler_init'
include/media/v4l2-dev.h:118 [kernel-doc WARN] : function name from comment differs: v4l2_prio_close v4l2_prio_check
include/media/v4l2-event.h:225 [kernel-doc WARN] : missing initial short description of 'v4l2_src_change_event_subscribe'[1] https://return42.github.io/linuxdoc/linux.html
The above are real issues at the documentation. On several cases,
caused by cut-and-paste.Fix them.
Signed-off-by: Mauro Carvalho Chehab
-
Shorten the tables by removing row numbers in comments, allowing for
later insertion of rows with minimal diffs.All changes have been generated by the following script.
import io
import re
import sysdef process_table(fname, data):
if fname.endswith('hist-v4l2.rst'):
data = re.sub(u'\n{1,2}\t( ?) -( ?) ?', u'\n\t\\1 -\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n(\t| )- \.\. row [0-9]+\n\t ?-( ?) ?', u'\\1* -\\2', data, flags = re.MULTILINE)
else:
data = re.sub(u'\n{1,2} -( ?) ?', u'\n -\\1', data, flags = re.MULTILINE)
data = re.sub(u'(\n?)(\n\n - \.\. row 1\n)', u'\n\\2', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n -( ?) ?', u' * -\\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. row [0-9]+\n \.\. (_[A-Z0-9_`-]*:)', u'\n - .. \\1', data, flags = re.MULTILINE)
data = re.sub(u'\n - \.\. (_[A-Z0-9_`-]*:)\n -', u' * .. \\1\n\n -', data, flags = re.MULTILINE)
data = re.sub(u'^ - ', u' -', data, flags = re.MULTILINE)
data = re.sub(u'^(\t{1,2}) ', u'\\1', data, flags = re.MULTILINE)return data
def process_file(fname, data):
buf = io.StringIO(data)
output = ''
in_table = False
table_separator = 0for line in buf.readlines():
if line.find('.. flat-table::') != -1:
in_table = True
table = ''
elif in_table and not re.match('^[\t\n]|( )', line):
in_table = False
output += process_table(fname, table)if in_table:
table += line
else:
output += lineif in_table:
in_table = False
output += process_table(fname, table)return output
fname = sys.argv[1]
data = file(fname, 'rb').read().decode('utf-8')
data = process_file(fname, data)
file(fname, 'wb').write(data.encode('utf-8'))Signed-off-by: Laurent Pinchart
-
Fix a few indentation issues to enable automated table reorganization
by a regex-based script.Signed-off-by: Laurent Pinchart
Signed-off-by: Mauro Carvalho Chehab
20 Sep, 2016
2 commits
-
Changeset ab6343956f9c ("[media] V4L2: Add documentation for SDI timings
and related flags") added documentation for new V4L2 defines, but
it forgot to update videodev2.h.rst.exceptions to point to where
the documentation for those new values will be inside the book,
causing those warnings:Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-dv-bt-std-sdi (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-dv-fl-first-field-extra-line (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-in-st-no-v-lock (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-in-st-no-std-lock (if the link has no caption the label must precede a section header)Fixes: ab6343956f9c ("[media] V4L2: Add documentation for SDI timings and related flags")
Cc: Charles-Antoine Couret
Cc: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab -
Describe new needed constants defined by SDI format.
Signed-off-by: Charles-Antoine Couret
Signed-off-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab
19 Sep, 2016
1 commit
-
Linux4Linux -> Video4Linux
Signed-off-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab
09 Sep, 2016
32 commits
-
The codes will be called:
MEDIA_BUS_FMT_SBGGR16_1X16
MEDIA_BUS_FMT_SGBRG16_1X16
MEDIA_BUS_FMT_SGRBG16_1X16
MEDIA_BUS_FMT_SRGGB16_1X16Signed-off-by: Sakari Ailus
Signed-off-by: Mauro Carvalho Chehab -
The codes will be called:
MEDIA_BUS_FMT_SBGGR14_1X14
MEDIA_BUS_FMT_SGBRG14_1X14
MEDIA_BUS_FMT_SGRBG14_1X14
MEDIA_BUS_FMT_SRGGB14_1X14Signed-off-by: Jouni Ukkonen
Signed-off-by: Sakari Ailus
Acked-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab -
The V4L2_PIX_FMT_SBGGR16 format is documented to contain samples of fewer
than 16 bits. However, we do have specific definitions for smaller sample
sizes. Therefore, this note is redundant from the API point of view.Currently only two drivers, am437x and davinci, use the
V4L2_PIX_FMT_SBGGR16 pixelformat currently. The sampling precision is
understood to be 16 bits in all current cases.Remove the note on sampling precision.
Signed-off-by: Sakari Ailus
Acked-by: Lad, Prabhakar
Signed-off-by: Mauro Carvalho Chehab -
The other raw bayer formats had a single sample depth dependent definition
whereas the 8-bit formats had one page for each. Unify the documentation
of the 8-bit formats.Signed-off-by: Sakari Ailus
Signed-off-by: Mauro Carvalho Chehab -
- Explicitly state that the most significant n bits are zeroed on 10 and
12 bpp formats.
- Remove extra comma from the last entry of the format list
- Add a missing colon before a list
- Use figures versus word numerals consistentlySigned-off-by: Sakari Ailus
Acked-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab -
The number of high order bits in samples was documented to be 6 for 12-bit
data. This is clearly wrong, fix it.Signed-off-by: Sakari Ailus
Acked-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab -
The 10-bit packed raw bayer format documented that the data of the first
pixel of a four-pixel group was found in the first byte and the two
highest bits of the fifth byte. This was not entirely correct. The two
bits in the fifth byte are the two lowest bits. The second pixel occupies
the second byte and third and fourth least significant bits and so on.Signed-off-by: Sakari Ailus
Acked-by: Aviv Greenberg
Acked-by: Hans Verkuil
Signed-off-by: Mauro Carvalho Chehab -
Ignore external C domain structs and functions used by VB2
header.Signed-off-by: Mauro Carvalho Chehab
-
The v4l2_m2m_dev is opaque: its meaning is only known by
v4l2-mem2mem.c. Ignore it on nitpick mode.Signed-off-by: Mauro Carvalho Chehab
-
There's a typo there, causing 4 warnings:
Documentation/media/uapi/rc/lirc-read.rst:26: WARNING: c:type reference target not found: name
Documentation/media/uapi/rc/lirc-read.rst:26: WARNING: c:type reference target not found: lirc
Documentation/media/uapi/v4l/func-poll.rst:25: WARNING: c:type reference target not found: name
Documentation/media/uapi/v4l/func-poll.rst:25: WARNING: c:type reference target not found: v4l2Fix them.
Signed-off-by: Mauro Carvalho Chehab
-
One reference there is still using :ref:. Fix it, to solve this
warning:
Documentation/media/uapi/mediactl/media-ioc-g-topology.rst:236: WARNING: undefined label: media-v2-intf-devnode (if the link has no caption the label must precede a section header)Signed-off-by: Mauro Carvalho Chehab
-
The struct v4l2_mpeg_vbi_ITV0 is identical to struct v4l2_mpeg_vbi_itv0,
except by its size, and it is documented at the same place at the
book.Fix cross reference for it.
Signed-off-by: Mauro Carvalho Chehab
-
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", a && mv a $k
done
for k in $(git grep -l "$j" Documentation/media/*.exceptions); do
sed s,$j,":c\:type\:\`$i\`", a && mv a $k
done
for k in $(git grep -l "$j" Documentation/); do
sed "s,:ref:\`$i \`,:c:type:\`$i\`," a && mv a $k
sed "s,:ref:\`$j\`,:c:type:\`$i\`," a && mv a $k
sed -E "s,:ref:\`(.*)\`,:c:type:\`\1\`," a && mv a $k
done
for k in $(git grep -l "" include/media); do
sed -E "s,:ref:\`(.*)\`,enum \&$i," a && mv a $k
done
doneSigned-off-by: Mauro Carvalho Chehab
-
Several structs were renamed or removed during V4L2 development.
Don't try to cross-reference the legacy ones.Signed-off-by: Mauro Carvalho Chehab
-
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: Mauro Carvalho Chehab
-
c:type is not the right tag for function definitions.
Replace them by .. c:function::Signed-off-by: Mauro Carvalho Chehab
-
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,' 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: Mauro Carvalho Chehab
-
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 $_' a && mv a $i; done
Signed-off-by: Mauro Carvalho Chehab
-
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=$1; $r=$2; if ($s eq $r) { s/\:c\:type\:\`struct\s+(\S+)\s*\\`/struct :c:type:`$2`/; s/struct\s+struct/struct/; s/(struct\s+\:c\:type\:\`\S+\`)\s+structure/$1/; }} print $_' a && mv a $i; done
Signed-off-by: Mauro Carvalho Chehab
-
Fix some CEC cross references that are broken.
Signed-off-by: Mauro Carvalho Chehab
-
Some structs are pointed via the typedef. As we replaced
those references, fix them.Signed-off-by: Mauro Carvalho Chehab
-
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
-
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
-
Add a table describing the fields on this struct, based
on ca.h header.Signed-off-by: Mauro Carvalho Chehab
-
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
-
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
-
The documentation follows what's there at the ca.h header.
Signed-off-by: Mauro Carvalho Chehab
-
Add a flat-table describing struct ca_caps, as found at
the source file.Signed-off-by: Mauro Carvalho Chehab
-
Now that we moved away from the :ref: type of references,
we need to update the exceptions lists.Signed-off-by: Mauro Carvalho Chehab
-
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_subdevUpdate the documentation to remove those.
Signed-off-by: Mauro Carvalho Chehab
-
The "struct" were inside the reference, causing it to break.
Acked-by: Laurent Pinchart
Signed-off-by: Mauro Carvalho Chehab -
There are several undocumented functions here; document them.
While here, make checkpatch.pl happy.
Signed-off-by: Mauro Carvalho Chehab
