Linux-Media Archive on lore.kernel.org
 help / color / Atom feed
From: Hans Verkuil <hverkuil@xs4all.nl>
To: Luca Ceresoli <luca@lucaceresoli.net>, linux-media@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 1/9] media: docs: v4l2-controls: fix sentence rendered in a nonsense way
Date: Fri, 14 Jun 2019 09:14:28 +0200
Message-ID: <069ac18c-7b9e-652a-1ff8-35fca09e6538@xs4all.nl> (raw)
In-Reply-To: <20190613141826.26775-1-luca@lucaceresoli.net>

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.
> 


  parent reply index

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-13 14:18 Luca Ceresoli
2019-06-13 14:18 ` [PATCH 2/9] media: docs: v4l2-controls: remove repeated ioctl names Luca Ceresoli
2019-06-13 14:18 ` [PATCH 3/9] media: docs: v4l2-controls: fix indentation Luca Ceresoli
2019-06-13 14:18 ` [PATCH 4/9] media: docs: v4l2-controls: add links to structs Luca Ceresoli
2019-06-13 14:18 ` [PATCH 5/9] media: docs: v4l2-controls: rearrange control initialization sequence Luca Ceresoli
2019-06-13 14:18 ` [PATCH 6/9] media: docs: v4l2-controls: add links to functions Luca Ceresoli
2019-06-13 14:18 ` [PATCH 7/9] media: docs: v4l2-controls: convert code blocks to C Luca Ceresoli
2019-06-13 14:18 ` [PATCH 8/9] media: docs: v4l2-controls: document file to include Luca Ceresoli
2019-06-13 14:18 ` [PATCH 9/9] media: docs: v4l2-controls: remove outdated paragraph Luca Ceresoli
2019-06-14  7:14 ` Hans Verkuil [this message]
2019-06-14 15:16   ` [PATCH 1/9] media: docs: v4l2-controls: fix sentence rendered in a nonsense way Luca Ceresoli

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=069ac18c-7b9e-652a-1ff8-35fca09e6538@xs4all.nl \
    --to=hverkuil@xs4all.nl \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=luca@lucaceresoli.net \
    --cc=mchehab@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-Media Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-media/0 linux-media/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-media linux-media/ https://lore.kernel.org/linux-media \
		linux-media@vger.kernel.org linux-media@archiver.kernel.org
	public-inbox-index linux-media


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-media


AGPL code for this site: git clone https://public-inbox.org/ public-inbox