]> git.baikalelectronics.ru Git - kernel.git/commit
drm/i915: Maintain consistent documentation subsection ordering
authorJonathan Corbet <corbet@lwn.net>
Thu, 23 May 2019 16:06:46 +0000 (10:06 -0600)
committerJonathan Corbet <corbet@lwn.net>
Fri, 24 May 2019 15:15:45 +0000 (09:15 -0600)
commit358fdb885db37ad6f103fc70b55b25f2e9c83694
tree8032003593df7a615c6e95afda87789c1beae49f
parent5c1587e6b57947b9b04bc4ec7b22ad3f59793c0b
drm/i915: Maintain consistent documentation subsection ordering

With Sphinx 2.0 (or prior versions with the deprecation warnings fixed) the
docs build fails with:

  Documentation/gpu/i915.rst:403: WARNING: Title level inconsistent:

  Global GTT Fence Handling
  ~~~~~~~~~~~~~~~~~~~~~~~~~

  reST markup error:
  Documentation/gpu/i915.rst:403: (SEVERE/4) Title level inconsistent:

I "fixed" it by changing the subsections in i915.rst, but that didn't seem
like the correct change.  It turns out that a couple of i915 files create
their own subsections in kerneldoc comments using apostrophes as the
heading marker:

  Layout
  ''''''

That breaks the normal subsection marker ordering, and newer Sphinx is
rather more strict about enforcing that ordering.  So fix the offending
comments to make Sphinx happy.

(This is unfortunate, in that kerneldoc comments shouldn't need to be aware
of where they might be included in the heading hierarchy, but I don't see
a better way around it).

Cc: stable@vger.kernel.org # v4.14+
Acked-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
drivers/gpu/drm/i915/i915_reg.h
drivers/gpu/drm/i915/intel_workarounds.c