summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* [media] videobuf2-v4l2.h: improve documentationMauro Carvalho Chehab2016-09-091-19/+33
| | | | | | | | | There are a few issues at the documentation: fields not documented, bad cross refrences, etc. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] videobuf2-v4l2.h: get kernel-doc tags from C fileMauro Carvalho Chehab2016-09-092-143/+150
| | | | | | | | There are several functions documented at the C file. Move them to the header, as this is the one used to build the media books. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] conf_nitpick.py: ignore C domain data used on vb2Mauro Carvalho Chehab2016-09-091-0/+4
| | | | | | | Ignore external C domain structs and functions used by VB2 header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] videobuf2-core.h: improve documentationMauro Carvalho Chehab2016-09-091-58/+85
| | | | | | | | | There are several small issues with the documentation. Fix them, in order to avoid producing warnings. While here, also make checkpatch.pl happy. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] videobuf2-core.h: document enum vb2_memoryMauro Carvalho Chehab2016-09-091-0/+14
| | | | | | This enum was not documented. Document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] videobuf2-core.h: move function descriptions from c fileMauro Carvalho Chehab2016-09-092-254/+269
| | | | | | | | There are several functions that were documented at the .c file. As we only include the headers, we need to move them to there, in order to have documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] conf_nitpick.py: ignore an opaque struct from v4l2-mem2mem.hMauro Carvalho Chehab2016-09-091-0/+4
| | | | | | | 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 <mchehab@s-opensource.com>
* [media] v4l2-mem2mem.h: make kernel-doc parse v4l2-mem2mem.h againMauro Carvalho Chehab2016-09-091-11/+5
| | | | | | | | | | The kernel-doc C parser doesn't like opaque structures. So, document it on another way. This should get rid of this warning: ./include/media/v4l2-mem2mem.h:62: error: Cannot parse struct or union! Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-mem2mem.h: document the public structuresMauro Carvalho Chehab2016-09-091-16/+51
| | | | | | | Most structures here are not documented. Add a documentation for them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-mem2mem.h: document function argumentsMauro Carvalho Chehab2016-09-091-13/+80
| | | | | | | There are lots of troubles with the function arguments on this file. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-mem2mem.h: move descriptions from .c fileMauro Carvalho Chehab2016-09-092-127/+133
| | | | | | | Several routines are somewhat documented at v4l2-mem2mem.c file. Move what's there to the header file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] mc-core.rst: fix a warning about an internal routineMauro Carvalho Chehab2016-09-091-1/+2
| | | | | | | | | | | Fix this warning: Documentation/media/kapi/mc-core.rst:97: WARNING: c:func reference target not found: media_devnode_release The media_device_release() is a function internal to media-devnode.c, and not exported elsewhere. So, we can't cross-reference it here. Make it explicit at the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] rc-map.h: fix a Sphinx warningMauro Carvalho Chehab2016-09-091-1/+1
| | | | | | ./include/media/rc-map.h:121: WARNING: Inline emphasis start-string without end-string. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix two wrong :name: tagsMauro Carvalho Chehab2016-09-092-2/+2
| | | | | | | | | | | | | 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: v4l2 Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] media-ioc-g-topology.rst: fix a c domain referenceMauro Carvalho Chehab2016-09-091-1/+1
| | | | | | | | 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 <mchehab@s-opensource.com>
* [media] dev-sliced-vbi.rst: fix reference for v4l2_mpeg_vbi_ITV0Mauro Carvalho Chehab2016-09-091-2/+4
| | | | | | | | | | 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 <mchehab@s-opensource.com>
* [media] docs-rst: fix cross-references for videodev2.hMauro Carvalho Chehab2016-09-0941-202/+201
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] hist-v4l2.rst: don't do refs to old structuresMauro Carvalho Chehab2016-09-091-12/+12
| | | | | | | Several structs were renamed or removed during V4L2 development. Don't try to cross-reference the legacy ones. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] libv4l-introduction.rst: improve crossr-referencesMauro Carvalho Chehab2016-09-091-13/+20
| | | | | | | | | 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 <mchehab@s-opensource.com>
* [media] libv4l-introdution.rst: fix function definitionsMauro Carvalho Chehab2016-09-091-27/+35
| | | | | | | c:type is not the right tag for function definitions. Replace them by .. c:function:: Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] fix clock_gettime cross-referencesMauro Carvalho Chehab2016-09-094-6/+6
| | | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix some broken struct referencesMauro Carvalho Chehab2016-09-094-21/+21
| | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: simplify c:type: cross referencesMauro Carvalho Chehab2016-09-0925-51/+51
| | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix cec bad cross-referencesMauro Carvalho Chehab2016-09-093-15/+10
| | | | | | Fix some CEC cross references that are broken. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix dmx bad cross-referencesMauro Carvalho Chehab2016-09-092-4/+3
| | | | | | | Some structs are pointed via the typedef. As we replaced those references, fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] fix broken references on dvb/video*rstMauro Carvalho Chehab2016-09-0913-6/+159
| | | | | | | | | | | | | 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 <mchehab@s-opensource.com>
* [media] docs-rst: fix the remaining broken links for DVB CA APIMauro Carvalho Chehab2016-09-097-11/+11
| | | | | | | 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 <mchehab@s-opensource.com>
* [media] ca-set-pid.rst: document struct ca_pidMauro Carvalho Chehab2016-09-091-1/+18
| | | | | | | Add a table describing the fields on this struct, based on ca.h header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] ca-get-slot-info.rst: document struct ca_slot_infoMauro Carvalho Chehab2016-09-091-1/+83
| | | | | | | | 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 <mchehab@s-opensource.com>
* [media] ca-get-msg.rst: add a boilerplate for struct ca_msgMauro Carvalho Chehab2016-09-091-1/+32
| | | | | | | | 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 <mchehab@s-opensource.com>
* [media] ca-get-descr-info.rst: add doc for for struct ca_descr_infoMauro Carvalho Chehab2016-09-091-1/+22
| | | | | | The documentation follows what's there at the ca.h header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] ca-get-cap.rst: add a table for struct ca_capsMauro Carvalho Chehab2016-09-091-1/+28
| | | | | | | Add a flat-table describing struct ca_caps, as found at the source file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst exceptions: use C domain references for DVB headersMauro Carvalho Chehab2016-09-0926-227/+144
| | | | | | | Now that we moved away from the :ref: type of references, we need to update the exceptions lists. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-subdev.h: fix a doc nitpick warningMauro Carvalho Chehab2016-09-091-1/+1
| | | | | | One markup tag is wrong here. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-subdev.rst: get rid of legacy functionsMauro Carvalho Chehab2016-09-091-16/+5
| | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-dv-timings.h: let kernel-doc parte the typedef argumentMauro Carvalho Chehab2016-09-091-2/+2
| | | | | | | Now that scripts/kernel-doc was fixed to parse the typedef argument used here, let it produce documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-device.h: fix some doc tagsMauro Carvalho Chehab2016-09-091-34/+34
| | | | | | | | | | Fix some minor issues at the documentation tags on this file, adding cross-references where needed, and fixing some broken ones. While here, fix a few spaces before tabs to make Checkpatch happier. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-dev.rst: fix a broken c domain referenceMauro Carvalho Chehab2016-09-091-1/+1
| | | | | | | The "struct" were inside the reference, causing it to break. Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-ioctl.h: document the remaining functionsMauro Carvalho Chehab2016-09-092-206/+305
| | | | | | | | There are several undocumented functions here; document them. While here, make checkpatch.pl happy. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] cec-ioc-dqevent.rst: fix some undefined referencesMauro Carvalho Chehab2016-09-091-2/+2
| | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-ctrls.h: Fix some c:type referencesMauro Carvalho Chehab2016-09-091-4/+4
| | | | | | Now that the uAPI is using c:type, let's use it here too. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: use C domain for enum references on uapiMauro Carvalho Chehab2016-09-098-23/+23
| | | | | | | Change the parse-headers.pl and the corresponding files to use the C domain for enum references. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-ctrls.h: fix doc reference for prepare_ext_ctrls()Mauro Carvalho Chehab2016-09-091-1/+1
| | | | | | | | The prepare_ext_ctrls() function is actually internal to the v4l2-ctrls.c implementation, so it doesn't have a declaration for the kAPI header to reference it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] diff-v4l.rst: Fix V4L version 1 referencesMauro Carvalho Chehab2016-09-091-19/+19
| | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: convert uAPI structs to C domainMauro Carvalho Chehab2016-09-09117-603/+603
| | | | | | | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] v4l2-ctrls: document some extra data structuresMauro Carvalho Chehab2016-09-091-7/+44
| | | | | | | The typedefs and a macro are not defined. While here, improve a few bits on the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] rc-map.h: document structs/enums on itMauro Carvalho Chehab2016-09-091-23/+71
| | | | | | | | | | | | There are some structs/enums that aren't documented via kernel-doc markup. Add documentation for them. Fix those warnings: ./include/media/rc-map.h:103: WARNING: c:type reference target not found: rc_map_list ./include/media/rc-map.h:110: WARNING: c:type reference target not found: rc_map_list ./include/media/rc-map.h:117: WARNING: c:type reference target not found: rc_map Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] conf_nitpick.py: ignore external functions used on mediactlMauro Carvalho Chehab2016-09-091-0/+3
| | | | | | | | | | | 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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: improve the kAPI documentation for the mediactlMauro Carvalho Chehab2016-09-093-123/+231
| | | | | | | | | | | | | | There are several issues on the documentation: - the media.h header were not properly referenced; - verbatim expressions were not properly marked as such; - struct member references were wrong; - some notes were not using the right markup; - a comment that were moved to the kernel-doc markup were duplicated as a comment inside the struct media_entity; - some args were not pointing to the struct they're using; - macros weren't documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] demux.h: fix a documentation warningMauro Carvalho Chehab2016-09-091-3/+5
| | | | | | | The kernel-doc parser didn't handle well the private: tag. Rewrite it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-16 10:19:16 +0100