Re: [PATCH 3/3] docs: Use underscore not hyphen in label

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Jan 31, 2019 at 03:06:23PM +1100, Tobin C. Harding wrote:
> From: "Tobin C. Harding" <tobin@xxxxxxxxxx>
> 
> sphinx emits warning
> 
>        WARNING: undefined label: memory-allocation ...

Weird, for me it works fine. The generated html at kernel.org [1] also
seems to be Ok...

What version of sphinx do you use?

[1] https://www.kernel.org/doc/html/latest/vm/index.html
> 
> This seems to be caused by the use of a hyphen in the label name instead
> of an underscore.  Using an underscore for the label name and the
> reference clears the warning.
> 
> Use underscore not hyphen in label and reference.
> 
> Signed-off-by: Tobin C. Harding <tobin@xxxxxxxxxx>
> ---
> 
> Not 100% sure this is the correct fix, please review.
> 
> thanks
> 
>  Documentation/core-api/memory-allocation.rst | 2 +-
>  Documentation/vm/index.rst                   | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst
> index 8954a88ff..39f35ebdc 100644
> --- a/Documentation/core-api/memory-allocation.rst
> +++ b/Documentation/core-api/memory-allocation.rst
> @@ -1,4 +1,4 @@
> -.. _memory-allocation:
> +.. _memory_allocation:
> 
>  =======================
>  Memory Allocation Guide
> diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
> index 2b3ab3a1c..b58cc3bfe 100644
> --- a/Documentation/vm/index.rst
> +++ b/Documentation/vm/index.rst
> @@ -4,7 +4,7 @@ Linux Memory Management Documentation
> 
>  This is a collection of documents about the Linux memory management (mm)
>  subsystem.  If you are looking for advice on simply allocating memory,
> -see the :ref:`memory-allocation`.
> +see the :ref:`memory_allocation`.
> 
>  User guides for MM features
>  ===========================
> -- 
> 2.20.1
> 

-- 
Sincerely yours,
Mike.




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux