[PATCH] Fix unaesthetic indentation

Subsystems: documentation, the rest

STALE2008d LANDED

Landed in mainline as 36d8900d2000 on 2021-02-22.

4 messages, 2 authors, 2021-02-15 · open the first message on its own page

[PATCH] Fix unaesthetic indentation

From: Matthew Wilcox <willy@infradead.org>
Date: 2021-02-15 16:25:40

The current documentation build looks like this:

$ make htmldocs
  SPHINX  htmldocs --> file:///home/willy/kernel/linux-next/Documentation/output
make[2]: Nothing to be done for 'html'.
WARNING: The kernel documentation build process
        support for Sphinx v3.0 and above is brand new. Be prepared for
        possible issues in the generated output.
        $

That extra indentation before my next prompt isn't pretty.  This patch
fixes it, but I'm not a pythonista, and maybe there's a better way.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 5bd45d5fb0a0..8a9ed3f29cd5 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -50,7 +50,7 @@ if major >= 3:
     sys.stderr.write('''WARNING: The kernel documentation build process
         support for Sphinx v3.0 and above is brand new. Be prepared for
         possible issues in the generated output.
-        ''')
+''')
     if (major > 3) or (minor > 0 or patch >= 2):
         # Sphinx c function parser is more pedantic with regards to type
         # checking. Due to that, having macros at c:function cause problems.

Re: [PATCH] Fix unaesthetic indentation

From: Jonathan Corbet <corbet@lwn.net>
Date: 2021-02-15 16:36:55

Matthew Wilcox [off-list ref] writes:
quoted hunk
The current documentation build looks like this:

$ make htmldocs
  SPHINX  htmldocs --> file:///home/willy/kernel/linux-next/Documentation/output
make[2]: Nothing to be done for 'html'.
WARNING: The kernel documentation build process
        support for Sphinx v3.0 and above is brand new. Be prepared for
        possible issues in the generated output.
        $

That extra indentation before my next prompt isn't pretty.  This patch
fixes it, but I'm not a pythonista, and maybe there's a better way.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 5bd45d5fb0a0..8a9ed3f29cd5 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -50,7 +50,7 @@ if major >= 3:
     sys.stderr.write('''WARNING: The kernel documentation build process
         support for Sphinx v3.0 and above is brand new. Be prepared for
         possible issues in the generated output.
-        ''')
+''')
The alternative would be:

          possible issues in the generated output.\n''')

jon

Re: [PATCH] Fix unaesthetic indentation

From: Matthew Wilcox <willy@infradead.org>
Date: 2021-02-15 16:39:01

On Mon, Feb 15, 2021 at 09:33:44AM -0700, Jonathan Corbet wrote:
Matthew Wilcox [off-list ref] writes:
quoted
The current documentation build looks like this:

$ make htmldocs
  SPHINX  htmldocs --> file:///home/willy/kernel/linux-next/Documentation/output
make[2]: Nothing to be done for 'html'.
WARNING: The kernel documentation build process
        support for Sphinx v3.0 and above is brand new. Be prepared for
        possible issues in the generated output.
        $

That extra indentation before my next prompt isn't pretty.  This patch
fixes it, but I'm not a pythonista, and maybe there's a better way.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 5bd45d5fb0a0..8a9ed3f29cd5 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -50,7 +50,7 @@ if major >= 3:
     sys.stderr.write('''WARNING: The kernel documentation build process
         support for Sphinx v3.0 and above is brand new. Be prepared for
         possible issues in the generated output.
-        ''')
+''')
The alternative would be:

          possible issues in the generated output.\n''')
Do you want me to submit a revised patch with that change?

Re: [PATCH] Fix unaesthetic indentation

From: Jonathan Corbet <corbet@lwn.net>
Date: 2021-02-15 18:22:37

Matthew Wilcox [off-list ref] writes:
quoted
The alternative would be:

          possible issues in the generated output.\n''')
Do you want me to submit a revised patch with that change?
No worries, I can tweak it.

Thanks,

jon
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help