Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] docs-rst: fix some broken struct references

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>

+21 -21
+1 -1
Documentation/media/uapi/cec/cec-func-poll.rst
··· 49 49 50 50 On success :c:func:`poll()` returns the number of file descriptors 51 51 that have been selected (that is, file descriptors for which the 52 - ``revents`` field of the respective :c:type:`struct pollfd` structure 52 + ``revents`` field of the respective struct :c:type:`pollfd` 53 53 is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in 54 54 the ``revents`` field if there are messages in the receive queue. If the 55 55 transmit queue has room for new messages, the ``POLLOUT`` and
+1 -1
Documentation/media/uapi/v4l/buffer.rst
··· 825 825 826 826 The struct :c:type:`v4l2_timecode` structure is designed to hold a 827 827 :ref:`smpte12m` or similar timecode. (struct 828 - :c:type:`struct timeval` timestamps are stored in struct 828 + struct :c:type:`timeval` timestamps are stored in struct 829 829 :c:type:`v4l2_buffer` field ``timestamp``.) 830 830 831 831
+2 -2
Documentation/media/uapi/v4l/dev-osd.rst
··· 44 44 ``base`` field of struct :c:type:`v4l2_framebuffer`. 45 45 The framebuffer device ioctl ``FBIOGET_FSCREENINFO`` returns the same 46 46 address in the ``smem_start`` field of struct 47 - :c:type:`struct fb_fix_screeninfo`. The ``FBIOGET_FSCREENINFO`` 48 - ioctl and struct :c:type:`struct fb_fix_screeninfo` are defined in 47 + struct :c:type:`fb_fix_screeninfo`. The ``FBIOGET_FSCREENINFO`` 48 + ioctl and struct :c:type:`fb_fix_screeninfo` are defined in 49 49 the ``linux/fb.h`` header file. 50 50 51 51 The width and height of the framebuffer depends on the current video
+17 -17
Documentation/media/uapi/v4l/hist-v4l2.rst
··· 37 37 enumerable. 38 38 39 39 1998-10-02: The ``id`` field was removed from struct 40 - :c:type:`struct video_standard` and the color subcarrier fields were 40 + struct :c:type:`video_standard` and the color subcarrier fields were 41 41 renamed. The :ref:`VIDIOC_QUERYSTD` ioctl was 42 42 renamed to :ref:`VIDIOC_ENUMSTD`, 43 43 :ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` to ··· 151 151 This change obsoletes the following ioctls: ``VIDIOC_S_INFMT``, 152 152 ``VIDIOC_G_INFMT``, ``VIDIOC_S_OUTFMT``, ``VIDIOC_G_OUTFMT``, 153 153 ``VIDIOC_S_VBIFMT`` and ``VIDIOC_G_VBIFMT``. The image format 154 - structure :c:type:`struct v4l2_format` was renamed to struct 154 + structure struct :c:type:`v4l2_format` was renamed to struct 155 155 :c:type:`v4l2_pix_format`, while struct 156 156 :c:type:`v4l2_format` is now the envelopping structure 157 157 for all format negotiations. ··· 254 254 2000-09-18: ``V4L2_BUF_TYPE_VBI`` was added. This may *break 255 255 compatibility* as the :ref:`VIDIOC_G_FMT <VIDIOC_G_FMT>` and 256 256 :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctls may fail now if the struct 257 - :c:type:`struct v4l2_fmt` ``type`` field does not contain 257 + struct :c:type:`v4l2_fmt` ``type`` field does not contain 258 258 ``V4L2_BUF_TYPE_VBI``. In the documentation of the struct 259 259 :c:type:`v4l2_vbi_format` ``offset`` field the 260 260 ambiguous phrase "rising edge" was changed to "leading edge". ··· 415 415 originally needed to distguish between variations of standards, were 416 416 removed. 417 417 418 - Struct :c:type:`struct v4l2_enumstd` ceased to be. 418 + Struct struct :c:type:`v4l2_enumstd` ceased to be. 419 419 :ref:`VIDIOC_ENUMSTD` now takes a pointer to a 420 420 struct :c:type:`v4l2_standard` directly. The 421 421 information which standards are supported by a particular video ··· 636 636 removed. Since no unadjusted system time clock was added to the 637 637 kernel as planned, the ``timestamp`` field changed back from type 638 638 stamp_t, an unsigned 64 bit integer expressing the sample time in 639 - nanoseconds, to struct :c:type:`struct timeval`. With the addition 639 + nanoseconds, to struct :c:type:`timeval`. With the addition 640 640 of a second memory mapping method the ``offset`` field moved into 641 641 union ``m``, and a new ``memory`` field of type enum 642 642 :ref:`v4l2_memory <v4l2-memory>` was added to distinguish between ··· 671 671 distinguish between field and frame (interlaced) overlay. 672 672 673 673 17. The digital zoom interface, including struct 674 - :c:type:`struct v4l2_zoomcap`, struct 675 - :c:type:`struct v4l2_zoom`, ``V4L2_ZOOM_NONCAP`` and 674 + struct :c:type:`v4l2_zoomcap`, struct 675 + struct :c:type:`v4l2_zoom`, ``V4L2_ZOOM_NONCAP`` and 676 676 ``V4L2_ZOOM_WHILESTREAMING`` was replaced by a new cropping and 677 677 scaling interface. The previously unused struct 678 - :c:type:`struct v4l2_cropcap` and :c:type:`struct v4l2_crop` 678 + struct :c:type:`v4l2_cropcap` and :c:type:`struct v4l2_crop` 679 679 where redefined for this purpose. See :ref:`crop` for details. 680 680 681 681 18. In struct :c:type:`v4l2_vbi_format` the ··· 694 694 Similar changes were made to struct 695 695 :c:type:`v4l2_outputparm`. 696 696 697 - 20. The struct :c:type:`struct v4l2_performance` and 697 + 20. The struct :c:type:`v4l2_performance` and 698 698 ``VIDIOC_G_PERF`` ioctl were dropped. Except when using the 699 699 :ref:`read/write I/O method <rw>`, which is limited anyway, this 700 700 information is already available to applications. ··· 882 882 3. The ``VIDIOC_G_COMP`` and ``VIDIOC_S_COMP`` ioctl were renamed to 883 883 ``VIDIOC_G_MPEGCOMP`` and ``VIDIOC_S_MPEGCOMP`` respectively. Their 884 884 argument was replaced by a struct 885 - :c:type:`struct v4l2_mpeg_compression` pointer. (The 885 + struct :c:type:`v4l2_mpeg_compression` pointer. (The 886 886 ``VIDIOC_G_MPEGCOMP`` and ``VIDIOC_S_MPEGCOMP`` ioctls where removed 887 887 in Linux 2.6.25.) 888 888 ··· 925 925 1. The ``clips`` field in struct :c:type:`v4l2_window` 926 926 must point to an array of struct :c:type:`v4l2_clip`, not 927 927 a linked list, because drivers ignore the struct 928 - :c:type:`struct v4l2_clip`. ``next`` pointer. 928 + struct :c:type:`v4l2_clip`. ``next`` pointer. 929 929 930 930 931 931 V4L2 in Linux 2.6.17 ··· 1040 1040 A new ``global_alpha`` field was added to 1041 1041 :c:type:`v4l2_window`, extending the structure. This 1042 1042 may *break compatibility* with applications using a struct 1043 - :c:type:`struct v4l2_window` directly. However the 1043 + struct :c:type:`v4l2_window` directly. However the 1044 1044 :ref:`VIDIOC_G/S/TRY_FMT <VIDIOC_G_FMT>` ioctls, which take a 1045 1045 pointer to a :c:type:`v4l2_format` parent structure 1046 1046 with padding bytes at the end, are not affected. ··· 1127 1127 1. The ``VIDIOC_G_CHIP_IDENT`` ioctl was renamed to 1128 1128 ``VIDIOC_G_CHIP_IDENT_OLD`` and ``VIDIOC_DBG_G_CHIP_IDENT`` was 1129 1129 introduced in its place. The old struct 1130 - :c:type:`struct v4l2_chip_ident` was renamed to 1131 - :c:type:`struct v4l2_chip_ident_old`. 1130 + struct :c:type:`v4l2_chip_ident` was renamed to 1131 + struct :c:type:`v4l2_chip_ident_old`. 1132 1132 1133 1133 2. The pixel formats ``V4L2_PIX_FMT_VYUY``, ``V4L2_PIX_FMT_NV16`` and 1134 1134 ``V4L2_PIX_FMT_NV61`` were added. ··· 1279 1279 V4L2 in Linux 3.6 1280 1280 ================= 1281 1281 1282 - 1. Replaced ``input`` in :c:type:`struct v4l2_buffer` by 1282 + 1. Replaced ``input`` in struct :c:type:`v4l2_buffer` by 1283 1283 ``reserved2`` and removed ``V4L2_BUF_FLAG_INPUT``. 1284 1284 1285 1285 2. Added V4L2_CAP_VIDEO_M2M and V4L2_CAP_VIDEO_M2M_MPLANE ··· 1293 1293 ================= 1294 1294 1295 1295 1. Added timestamp types to ``flags`` field in 1296 - :c:type:`struct v4l2_buffer`. See :ref:`buffer-flags`. 1296 + struct :c:type:`v4l2_buffer`. See :ref:`buffer-flags`. 1297 1297 1298 1298 2. Added ``V4L2_EVENT_CTRL_CH_RANGE`` control event changes flag. See 1299 1299 :ref:`ctrl-changes-flags`. ··· 1320 1320 V4L2 in Linux 3.14 1321 1321 ================== 1322 1322 1323 - 1. In struct :c:type:`struct v4l2_rect`, the type of ``width`` and 1323 + 1. In struct :c:type:`v4l2_rect`, the type of ``width`` and 1324 1324 ``height`` fields changed from _s32 to _u32. 1325 1325 1326 1326