Re: [PATCH 1/3] Docs: An initial automarkup extension for sphinx

[Jonathan Corbet]

On Fri, 21 Jun 2019 22:00:46 -0300
Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx> wrote:

> > +#
> > +# The DVB docs create references for these basic system calls, leading
> > +# to lots of confusing links.  So just don't link them.
> > +#
> > +Skipfuncs = [ 'open', 'close', 'write' ]  
> 
> and yeah, of course, if there's something weird, it has to be at
> the media docs :-)
> 
> Btw, if I'm not mistaken, we do the same for ioctl.

So that's actually interesting.  In, for example,
Documentation/media/uapi/v4l/func-ioctl.rst, you see something that looks
like this:

> .. c:function:: int ioctl( int fd, int request, void *argp )
>     :name: v4l2-ioctl

Some digging around didn't turn up any documentation for :name:, but it
seems to prevent ioctl() from going into the list of functions that can be
cross-referenced.  I wonder if the same should be done for the others?  I
think that would be better than putting a special-case hack into the
toolchain.

> I'm wandering if this could also handle the Documentation/* auto-replace.

I think it's the obvious place for it, yes.  Let's make sure I haven't
badly broken anything with the existing change first, though :)

Thanks,

jon