linux-kernel - Re: [PATCH v2] doc:process: add links where missing

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, 21 Nov 2018 05:23:46 -0800
From:   Matthew Wilcox <willy@...radead.org>
To:     Federico Vaga <federico.vaga@...a.pv.it>
Cc:     Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] doc:process: add links where missing

On Wed, Nov 21, 2018 at 01:35:19AM +0100, Federico Vaga wrote:
> Some documents are refering to others without links. With this
> patch I add those missing links.

I am a neophyte to ReST, but ...

> +++ b/Documentation/dev-tools/coccinelle.rst
> @@ -4,6 +4,8 @@
>  
>  .. highlight:: none
>  
> +.. _devtools_coccinelle:
> +
>  Coccinelle
>  ==========
>  

> +++ b/Documentation/process/4.Coding.rst
> @@ -315,7 +315,8 @@ variety of potential coding problems; it can also propose fixes for those
>  problems.  Quite a few "semantic patches" for the kernel have been packaged
>  under the scripts/coccinelle directory; running "make coccicheck" will run
>  through those semantic patches and report on any problems found.  See
> -Documentation/dev-tools/coccinelle.rst for more information.
> +:ref:`Documentation/dev-tools/coccinelle.rst <devtools_coccinelle>`
> +for more information.

when I tried to do something like this yesterday, I discovered that
doing:

+.. _memory_allocation:

didn't work, and I had to do:

+.. _memory-allocation:

instead.  Also, when doing 'ref', do we want this style of ref, or do we
prefer the plain:

:ref:`devtools-coccinelle`

which is what I did yesterday.  Maybe that's why yours works with the
underscores and mine didn't?