linux-kernel - Re: [PATCH v4 38/52] docs: block: typec

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 30 Sep 2020 13:48:25 -0300
From:   André Almeida <andrealmeid@...labora.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
Cc:     Jens Axboe <axboe@...nel.dk>, Randy Dunlap <rdunlap@...radead.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 38/52] docs: block: typec_bus.rst: get rid of :c:type

On 9/30/20 10:25 AM, Mauro Carvalho Chehab wrote:
> The :c:type macros are not used properly there, as reported
> by Sphinx 3:
> 
> 	./Documentation/block/blk-mq.rst:112: WARNING: Unparseable C cross-reference: 'hctx->dispatch'
> 	Invalid C declaration: Expected end of definition. [error at 4]
> 	  hctx->dispatch
> 	  ----^
> 
> Also, they won't be generating any cross references.
> 
> So, replace them by a literal markup.

Your commit message says "docs: block: typec_bus.rst: ...", but the name
of this file is "blk-mq.rst".

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

After solving the issue above:

Reviewed-by: André Almeida <andrealmeid@...labora.com>

> ---
>  Documentation/block/blk-mq.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/block/blk-mq.rst b/Documentation/block/blk-mq.rst
> index 86a632af02b0..a980d23af48c 100644
> --- a/Documentation/block/blk-mq.rst
> +++ b/Documentation/block/blk-mq.rst
> @@ -110,9 +110,9 @@ block layer removes requests from the associated software queues and tries to
>  dispatch to the hardware.
>  
>  If it's not possible to send the requests directly to hardware, they will be
> -added to a linked list (:c:type:`hctx->dispatch`) of requests. Then,
> +added to a linked list (``hctx->dispatch``) of requests. Then,
>  next time the block layer runs a queue, it will send the requests laying at the
> -:c:type:`dispatch` list first, to ensure a fairness dispatch with those
> +``dispatch`` list first, to ensure a fairness dispatch with those
>  requests that were ready to be sent first. The number of hardware queues
>  depends on the number of hardware contexts supported by the hardware and its
>  device driver, but it will not be more than the number of cores of the system.
>