public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Mike Rapoport <rppt@linux.ibm.com>
To: "Tobin C. Harding" <me@tobin.cc>
Cc: Jonathan Corbet <corbet@lwn.net>,
	"Tobin C. Harding" <tobin@kernel.org>,
	Christopher Lameter <cl@linux.com>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH 3/3] docs: Use underscore not hyphen in label
Date: Thu, 31 Jan 2019 11:27:57 +0200	[thread overview]
Message-ID: <20190131092757.GF28876@rapoport-lnx> (raw)
In-Reply-To: <20190131040623.15569-4-me@tobin.cc>

On Thu, Jan 31, 2019 at 03:06:23PM +1100, Tobin C. Harding wrote:
> From: "Tobin C. Harding" <tobin@kernel.org>
> 
> 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@kernel.org>
> ---
> 
> 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.


  reply	other threads:[~2019-01-31  9:28 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-31  4:06 [PATCH 0/3] docs: vm: Fix typo and build warnings Tobin C. Harding
2019-01-31  4:06 ` [PATCH 1/3] docs: Fix SLUB docs typo Tobin C. Harding
2019-01-31  9:30   ` Mike Rapoport
2019-01-31  4:06 ` [PATCH 2/3] docs: Add missing colon Tobin C. Harding
2019-01-31  9:30   ` Mike Rapoport
2019-01-31  4:06 ` [PATCH 3/3] docs: Use underscore not hyphen in label Tobin C. Harding
2019-01-31  9:27   ` Mike Rapoport [this message]
2019-01-31 20:56     ` Tobin C. Harding
2019-02-01 23:03       ` Jonathan Corbet
2019-02-02 14:32         ` Mike Rapoport
2019-02-03 23:20           ` Tobin C. Harding
2019-02-04  8:38             ` Mike Rapoport
2019-02-04 21:12           ` Tobin C. Harding
2019-02-04 23:03             ` Jonathan Corbet
2019-02-05  8:30               ` Markus Heiser
2019-02-06  4:27                 ` Tobin C. Harding
2019-02-06  7:49                   ` Markus Heiser
2019-02-06 20:28                     ` Tobin C. Harding

Reply instructions:

You may reply publicly 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=20190131092757.GF28876@rapoport-lnx \
    --to=rppt@linux.ibm.com \
    --cc=cl@linux.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=me@tobin.cc \
    --cc=tobin@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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox