Re: [PATCH] Documentation: memory - fix warning

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

 



On Tue, Apr 7, 2020 at 9:24 PM Jonathan Corbet <corbet@xxxxxxx> wrote:
>
> On Mon,  6 Apr 2020 22:07:43 +0000
> Lothar Rubusch <l.rubusch@xxxxxxxxx> wrote:
>
> > The label in sphinx can refer to a document section but not to the document
> > header.
> >
> > The handle 'memory_allocation' is used in another document(s) to refer to
> > GFP_KERNEL flags description in this modified document.
> >
> > Since the sphinx label does not work as it is placed here, a proposal is to
> > better shift it to the section about memory allocation flags.
> >
> > Signed-off-by: Lothar Rubusch <l.rubusch@xxxxxxxxx>
>
> So I don't see any warnings associated with this label; what are you
> seeing and how are you getting it?  Which version of Sphinx are you
> running?

My setup says "Running Sphinx v1.8.4". My sources are cloned from
git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/staging.git from
branch testing-staging
Am I doing this correctly?

I tried
$ git clean -fxd
$ make htmldocs
(...)
writing output... [ 16%] block/request .. crypto/api-akcipher
./include/linux/slab.h:503: WARNING: undefined label:
memory-allocation (if the link has no caption the label must precede a
section header)
writing output... [ 19%] crypto/api-digest .. driver-api/dmaengine/client
(...)

Alternatively, on plain console I see the following
$ make htmldocs
(...)
preparing documents... done
./include/linux/slab.h:503: WARNING: undefined label:
memory-allocation (if the link has no caption the label must precede a
section header)
/home/user/linux/Documentation/networking/devlink/devlink-trap.rst:302:
WARNING: undefined label: generic-packet-trap-groups (if the link has
no caption the label must precede a section header)
writing output... [100%] xtensa/mmu
waiting for workers...
(...)

Is this reproducible to you?

Honestly, I figured out my current patch fixes nothing. I see
definitely a warning there,
but the problem is different:

A working referrer e.g. in Documentation/vm/index.rst:5
:ref:`Documentation/core-api/memory-allocation.rst <memory_allocation>`

The erronous referrer in /include/linux/slab.h:503
:ref:`Documentation/core-api/memory-allocation.rst <memory-allocation>`

Now this is really embarrassing! Can it be that I should rather have
replaced the '-' by a '_'?

I would like to file a patch v2. Please rather consider the second
patch, if this warning is reproducable to you guys.
I appologize for not having checked enough!

Best,
Lothar



[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