| Message ID | 20190613141826.26775-1-luca@lucaceresoli.net (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [1/9] media: docs: v4l2-controls: fix sentence rendered in a nonsense way | expand |
On 6/13/19 4:18 PM, Luca Ceresoli wrote: > This sentence renders as: > >> Since such compound controls need to expose more information about >> themselves than is possible with ioctls VIDIOC_QUERYCTRL, >> VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU the VIDIOC_QUERY_EXT_CTRL > ^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^ >> ioctl was added. > > This does not make sense. Fix by providing an explicit link text. This > results in: > >> Since such compound controls need to expose more information about >> themselves than is possible with VIDIOC_QUERYCTRL and VIDIOC_QUERYMENU >> the VIDIOC_QUERY_EXT_CTRL ioctl was added. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > --- > Documentation/media/uapi/v4l/extended-controls.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst > index 24274b398e63..0968aa9cd167 100644 > --- a/Documentation/media/uapi/v4l/extended-controls.rst > +++ b/Documentation/media/uapi/v4l/extended-controls.rst > @@ -86,7 +86,7 @@ with compound types should only be used programmatically. > > Since such compound controls need to expose more information about > themselves than is possible with > -:ref:`VIDIOC_QUERYCTRL` the > +:ref:`VIDIOC_QUERYCTRL and VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` the This should just refer to VIDIOC_QUERYCTRL, not QUERYMENU. So this becomes: :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` Regards, Hans > :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>` ioctl was added. In > particular, this ioctl gives the dimensions of the N-dimensional array > if this control consists of more than one element. >
Hi Hans, On 14/06/19 09:14, Hans Verkuil wrote: > On 6/13/19 4:18 PM, Luca Ceresoli wrote: >> This sentence renders as: >> >>> Since such compound controls need to expose more information about >>> themselves than is possible with ioctls VIDIOC_QUERYCTRL, >>> VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU the VIDIOC_QUERY_EXT_CTRL >> ^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^ >>> ioctl was added. >> >> This does not make sense. Fix by providing an explicit link text. This >> results in: >> >>> Since such compound controls need to expose more information about >>> themselves than is possible with VIDIOC_QUERYCTRL and VIDIOC_QUERYMENU >>> the VIDIOC_QUERY_EXT_CTRL ioctl was added. >> >> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >> --- >> Documentation/media/uapi/v4l/extended-controls.rst | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst >> index 24274b398e63..0968aa9cd167 100644 >> --- a/Documentation/media/uapi/v4l/extended-controls.rst >> +++ b/Documentation/media/uapi/v4l/extended-controls.rst >> @@ -86,7 +86,7 @@ with compound types should only be used programmatically. >> >> Since such compound controls need to expose more information about >> themselves than is possible with >> -:ref:`VIDIOC_QUERYCTRL` the >> +:ref:`VIDIOC_QUERYCTRL and VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` the > > This should just refer to VIDIOC_QUERYCTRL, not QUERYMENU. So this > becomes: :ref:`VIDIOC_QUERYCTRL <VIDIOC_QUERYCTRL>` Thanks for your prompt review. v2 on its way with this patch only, since you already added the other ones in your latest pull request.
diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst index 24274b398e63..0968aa9cd167 100644 --- a/Documentation/media/uapi/v4l/extended-controls.rst +++ b/Documentation/media/uapi/v4l/extended-controls.rst @@ -86,7 +86,7 @@ with compound types should only be used programmatically. Since such compound controls need to expose more information about themselves than is possible with -:ref:`VIDIOC_QUERYCTRL` the +:ref:`VIDIOC_QUERYCTRL and VIDIOC_QUERYMENU <VIDIOC_QUERYCTRL>` the :ref:`VIDIOC_QUERY_EXT_CTRL <VIDIOC_QUERYCTRL>` ioctl was added. In particular, this ioctl gives the dimensions of the N-dimensional array if this control consists of more than one element.