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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1476873877-9538-1-git-send-email-jani.nikula@intel.com>
Date:   Wed, 19 Oct 2016 13:44:37 +0300
From:   Jani Nikula <jani.nikula@...el.com>
To:     Markus Heiser <markus.heiser@...marit.de>,
        Jonathan Corbet <corbet@....net>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Jani Nikula <jani.nikula@...el.com>
Subject: [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@...marit.de>
Signed-off-by: Jani Nikula <jani.nikula@...el.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