Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitdaaaf58

Browse files
mchehabgregkh
authored andcommitted
scripts: get_abi.pl: Don't let ABI files to create subtitles
The ReST output should only contain documentation titlesautomatically created by the script.There are two reasons for that:1) Consistency. just a handful ABI docs define titles2) To avoid critical errors. Docutils (which is the basis for Sphinx) allows a free assign of documentation title markups. So, one document could be doing things like:Level 1=======Level 2------- While another one could do the reverse:Level 1-------Level 2======= But the same document can't mix. As the output of get_abi.pl will join contents from multiple files, if they don't define the levels on a consistent errors, errors like this can happen:Sphinx parallel build error:docutils.utils.SystemMessage: /home/rdunlap/lnx/lnx-510-rc2/Documentation/ABI/testing/sysfs-bus-rapidio:2: (SEVERE/4) Title level inconsistent:Attributes Common for All RapidIO Devices----------------------------------------- Which cause some versions of Sphinx to go into an endless loop. It should be noticed that an alternative to that would be to replace all title occurrences by a single markup, but that will make the parser more complex, and, due to (1) it would generate an inconsistent output. So, better to just remove the titles defined at the ABI files from the output.Reported-by: Randy Dunlap <rdunlap@infradead.org>Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>Link:https://lore.kernel.org/r/6c62ef5c01d39dee8d891f8390c816d2a889670a.1604312590.git.mchehab+huawei@kernel.orgSigned-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parente186d80 commitdaaaf58

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

‎scripts/get_abi.pl‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,12 @@ sub output_rest {
352352

353353
if (!($desc =~/^\s*$/)) {
354354
if ($description_is_rst) {
355+
# Remove title markups from the description
356+
# Having titles inside ABI files will only work if extra
357+
# care would be taken in order to strictly follow the same
358+
# level order for each markup.
359+
$desc =~s/\n[\-\*\=\^\~]+\n/\n\n/g;
360+
355361
# Enrich text by creating cross-references
356362

357363
$desc =~s,Documentation/(?!devicetree)(\S+)\.rst,:doc:`/$1`,g;

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp