summaryrefslogtreecommitdiff
path: root/include/drm
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2019-05-23 10:06:46 -0600
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2019-06-11 12:20:56 +0200
commit6600ec2600d63868efa8c6641375451677469b24 (patch)
treeb09a98ac9e36cd808e2b641ef12b6ffc794a79fb /include/drm
parent360e00e290a355219425b5ea0ca62d9df3261fa1 (diff)
drm/i915: Maintain consistent documentation subsection ordering
commit 551bd3368a7b3cfef01edaade8970948d178d40a upstream. 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> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'include/drm')
0 files changed, 0 insertions, 0 deletions