Re: [PATCH 5.1 56/85] doc: Cope with the deprecation of AutoReporter

[Jiri Slaby]

On 10. 06. 19, 9:31, Greg Kroah-Hartman wrote:
> On Mon, Jun 10, 2019 at 08:27:30AM +0200, Jiri Slaby wrote:
>> On 07. 06. 19, 17:39, Greg Kroah-Hartman wrote:
>>> From: Jonathan Corbet <corbet@xxxxxxx>
>>>
>>> commit 2404dad1f67f8917e30fc22a85e0dbcc85b99955 upstream.
>>>
>>> AutoReporter is going away; recent versions of sphinx emit a warning like:
>>>
>>>   Documentation/sphinx/kerneldoc.py:125:
>>>       RemovedInSphinx20Warning: AutodocReporter is now deprecated.
>>>       Use sphinx.util.docutils.switch_source_input() instead.
>>>
>>> Make the switch.  But switch_source_input() only showed up in 1.7, so we
>>> have to do ugly version checks to keep things working in older versions.
>>
>> Hi,
>>
>> this patch breaks our build of kernel-docs on 5.1.*:
>> https://build.opensuse.org/package/live_build_log/Kernel:stable/kernel-docs/standard/x86_64
>>
>> The error is:
>> [  250s] reST markup error:
>> [  250s]
>> /home/abuild/rpmbuild/BUILD/kernel-docs-5.1.8/linux-5.1/Documentation/gpu/i915.rst:403:
>> (SEVERE/4) Title level inconsistent:
>> [  250s]
>> [  250s] Global GTT Fence Handling
>> [  250s] ~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> Reverting the patch from 5.1.* makes it work again.
>>
>> 5.2-rc3 (includes the patch) is OK:
>> https://build.opensuse.org/package/live_build_log/Kernel:HEAD/kernel-docs/standard/x86_64
>>
>> So 5.1.* must be missing something now.
> 
> Odd.  running 'make htmldocs' on 5.1 with these patches applied works
> for me here.
> 
> What version of sphinx are you using to build the package with?

>From the log, it looks like 1.8.5 (it's tumbleweed):

$ osc rbl Kernel:stable/kernel-docs/standard/x86_64|grep -i sphinx
[   11s] cycle: python3-sphinx_rtd_theme -> python3-Sphinx
[   11s]   breaking dependency python3-Sphinx -> python3-sphinx_rtd_theme
[   32s] [226/263] cumulate python3-sphinxcontrib-websupport-1.1.0-1.2
[   32s] [239/263] cumulate python3-Sphinx-1.8.5-2.2
[   32s] [242/263] cumulate python3-sphinx_rtd_theme-0.4.1-1.3
[   72s]
python3-sphinxcontrib-websupport-1.1.0########################################
[   72s] python3-sphinx_rtd_theme-0.4.1-1.3
########################################
[   73s] python3-Sphinx-1.8.5-2.2
########################################
[   73s] update-alternatives: using /usr/bin/sphinx-apidoc-3.7 to
provide /usr/bin/sphinx-apidoc (sphinx-apidoc) in auto mode
[  101s] + patch -s -F0 -E -p1 --no-backup-if-mismatch -i
/home/abuild/rpmbuild/BUILD/kernel-docs-5.1.8/patches.kernel.org/5.1.8-055-docs-Fix-conf.py-for-Sphin-2.0.patch
[  101s] + patch -s -F0 -E -p1 --no-backup-if-mismatch -i
/home/abuild/rpmbuild/BUILD/kernel-docs-5.1.8/patches.kernel.org/5.1.8-057-doc-Cope-with-Sphinx-logging-deprecations.patch
[  102s]   SPHINX  htmldocs -->
file:///home/abuild/rpmbuild/BUILD/kernel-docs-5.1.8/linux-5.1/html/Documentation/output
[  103s] Running Sphinx v1.8.5

thanks,
-- 
js
suse labs