Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1503618 > unrolled thread

[PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py Jani Nikula <jani.nikula@intel.com> - 2016-10-19 16:20 +0200
    Re: [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py Markus Heiser <markus.heiser@darmarit.de> - 2016-10-19 16:40 +0200
    Re: [PATCH] Documentation/sphinx: rename kernel-doc.py to  kerneldoc.py Jonathan Corbet <corbet@lwn.net> - 2016-10-21 22:30 +0200

#1503618 — [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py

Python module names should not have hyphens per [PEP 8]. Drop the hyphen
from kernel-doc.py. The extension directive remains unchanged.

[PEP 8] https://www.python.org/dev/peps/pep-0008/#package-and-module-names

Reported-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Documentation/conf.py                                | 2 +-
 Documentation/sphinx/{kernel-doc.py => kerneldoc.py} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename Documentation/sphinx/{kernel-doc.py => kerneldoc.py} (100%)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 0cc8765d3f98..bebab599a09b 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -34,7 +34,7 @@ from load_config import loadConfig
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['kernel-doc', 'rstFlatTable', 'kernel_include', 'cdomain']
+extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain']
 
 # The name of the math extension changed on Sphinx 1.4
 if minor > 3:
diff --git a/Documentation/sphinx/kernel-doc.py b/Documentation/sphinx/kerneldoc.py
similarity index 100%
rename from Documentation/sphinx/kernel-doc.py
rename to Documentation/sphinx/kerneldoc.py
-- 
2.1.4

[toc] | [next] | [standalone]

#1503708

Am 19.10.2016 um 12:44 schrieb Jani Nikula <jani.nikula@intel.com>:

> Python module names should not have hyphens per [PEP 8]. Drop the hyphen
> from kernel-doc.py. The extension directive remains unchanged.
> 
> [PEP 8] https://www.python.org/dev/peps/pep-0008/#package-and-module-names
> 
> Reported-by: Markus Heiser <markus.heiser@darmarit.de>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Wow! .. you are fast ;-) / Thanks!

--M--

[toc] | [prev] | [next] | [standalone]

#1506269 — Re: [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py

On Wed, 19 Oct 2016 13:44:37 +0300
Jani Nikula <jani.nikula@intel.com> wrote:

> Python module names should not have hyphens per [PEP 8]. Drop the hyphen
> from kernel-doc.py. The extension directive remains unchanged.
> 
> [PEP 8] https://www.python.org/dev/peps/pep-0008/#package-and-module-names

I've applied this, thanks.

I don't know how many times I've run into the hyphens-in-module-names
thing in Python; one of those little irritations.

jon

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web