On 1/6/23 08:59, David Marchand wrote: > On Thu, Jan 5, 2023 at 8:34 PM Ilya Maximets <[email protected]> wrote: >> >> The text enclosed in '<...>' supposed to be an actual link and not the >> name of the link. This generates incorrect links that lead nowhere. > > Indeed. > I was wondering if you have access to openvswitch.org http logs, to > catch other dead links, perhaps?
I found these by running 'make docs-check' locally. The result might depend on the sphinx version though as I do not remember seeing these errors in the past. I have Sphinx 4.4.0 right now. There is also 'make check-docs' (horrible naming :D ) that invokes the full link check and it can detect broken links, redirects or unavailable resources as it actually queries these links. For example, we currently have a broken link to iproute2 git in the docs... > >> >> Also, a single underscore supposed to be used for external links. > > On that side, it won't hurt. > I don't have a strong opinion, but we have many other instances of > such use in other docs, so it could go in a separate global cleanup. The line between _ and __ is a bit blurry and in most cases they give the same result, so I'm not sure if we need to fix the links which are not actually broken. > >> >> Signed-off-by: Ilya Maximets <[email protected]> > > Generated links are better now :-). > > With or without __ cleanup: > Reviewed-by: David Marchand <[email protected]> > Thanks! Applied and backported down to 2.17. Best regards, Ilya Maximets. _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
