Re: [GIT PULL] Documentation for 5.10

[Mauro Carvalho Chehab]

Hi Linus,

Em Mon, 12 Oct 2020 13:30:42 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> As hoped, things calmed down for docs this cycle; fewer changes and almost
> no conflicts at all.  This pull includes:
> 
>  - A reworked and expanded user-mode Linux document
>  - Some simplifications and improvements for submitting-patches.rst
>  - An emergency fix for (some) problems with Sphinx 3.x
>  - Some welcome automarkup improvements to automatically generate
>    cross-references to struct definitions and other documents
>  - The usual collection of translation updates, typo fixes, etc.
> 
> NOTE that there will be a largish  late-window pull request coming,
> probably directly from Mauro.  Sphinx 3.x has broken a bunch of things,
> which is obnoxious, though the end result is better; fixing the problems
> requires a number of cross-tree documentation tweaks.  These are best done
> toward the end to avoid creating unnecessary conflicts with other trees.

I double-checked: after having both docs and media tree pulled upstream, 
80% of the patches should apply cleanly.

So, I just merged the ones that apply cleanly at my -next tree:

	https://git.linuxtv.org/mchehab/media-next.git/ (master branch)

If everything goes well on tomorrow's next, I'll send you a pull request
with those.

The other ones depend on merges from DRM, hwmon and other
trees. So, I'll keep rebasing them and should be sending you a late
PR by the end of the merge window, fixing the remaining doc issues.

We're aiming to have zero documentation warnings by
the end of the merge window, when built with Sphinx 2.x,
and just a handful set of warnings with Sphinx 3.1+[1].

[1] One of the limitations of Sphinx C cross-reference code,
    up to its latest version, is that it doesn't allow to have
    both a function called "foo" and a struct or enum also called
    "foo".

    With Sphinx < 3, this doesn't generate warnings, but it still
    cause troubles with cross-references. Sphinx 3.x warns
    about name clashes, but the bug was not solved yet upstream.
    They're working on Sphinx to fix that in the future:

	https://github.com/sphinx-doc/sphinx/issues/8241
	https://github.com/sphinx-doc/sphinx/issues/7819

Thanks,
Mauro