Re: [PATCH bpf-next] bpf, doc: use internal linking for link to netdev FAQ

David Vernet
2023-03-13T14:32:49Z

On Mon, Mar 13, 2023 at 08:27:11AM -0600, Jonathan Corbet wrote:
> David Vernet <void@manifault.com> writes:
>
> >> In this specific case, though, there is a better solution. Text like:
> >>
> >> see the netdev FAQ (Documentation/process/maintainer-netdev.rst)
> >>
> >> will add links in the built docs, and also tells readers of the
> >> plain-text files where they should be looking. Without adding warnings.
> >
> > Nice, seems like the best of both worlds. A syntax clarification
> > question: are you saying that this would work?
> >
> >> see the `netdev-FAQ`_.
> >>
> >> <snip>
> >>
> >> .. _netdev-FAQ: Documentation/process/maintainer-netdev.rst
> >
> > Or is it required to have the full path inline in the text, as in your
> > example:
> >
> >> see the netdev FAQ (Documentation/process/maintainer-netdev.rst)
> >
> > The benefit of the former is of course that you only have to specify the
> > link in one place.
>
> Yeah, but the latter is what we actually have.

Ack, just wanted to make sure I understood the suggestion. I think this
is just fine. There's really no need to add 5 - 6 links in the same file
anyways.

Bagas would you be OK with submitting a v2 patch which changes the first
instance of the `netdev-FAQ`_ to netdev FAQ
(Documentation/process/maintainer-netdev.rst) per Jon's suggestion?

Thanks,
David