Commit 992a9df4 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: bring some order to our Python module hierarchy 



Now that we have tools/lib/python for our Python modules, turn them into
proper packages with a single namespace so that everything can just use
tools/lib/python in sys.path.  No functional change.

Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <20251110220430.726665-3-corbet@lwn.net>
parent 778b8ebe

Documentation/sphinx/kernel_abi.py

+2 −2
Original line number Diff line number Diff line
@@ -43,9 +43,9 @@ from sphinx.util.docutils import switch_source_input 
from sphinx.util import logging



srctree = os.path.abspath(os.environ["srctree"])

sys.path.insert(0, os.path.join(srctree, "tools/lib/python/abi"))

sys.path.insert(0, os.path.join(srctree, "tools/lib/python"))



from abi_parser import AbiParser

from abi.abi_parser import AbiParser



__version__ = "1.0"

Documentation/sphinx/kernel_include.py

+2 −2
Original line number Diff line number Diff line
@@ -97,9 +97,9 @@ from docutils.parsers.rst.directives.body import CodeBlock, NumberLines 
from sphinx.util import logging



srctree = os.path.abspath(os.environ["srctree"])

sys.path.insert(0, os.path.join(srctree, "tools/lib/python/kdoc"))

sys.path.insert(0, os.path.join(srctree, "tools/lib/python"))



from parse_data_structs import ParseDataStructs

from kdoc.parse_data_structs import ParseDataStructs



__version__ = "1.0"

logger = logging.getLogger(__name__)

Documentation/sphinx/kerneldoc.py

+3 −3
Original line number Diff line number Diff line
@@ -42,10 +42,10 @@ from sphinx.util import logging 
from pprint import pformat



srctree = os.path.abspath(os.environ["srctree"])

sys.path.insert(0, os.path.join(srctree, "tools/lib/python/kdoc"))

sys.path.insert(0, os.path.join(srctree, "tools/lib/python"))



from kdoc_files import KernelFiles

from kdoc_output import RestFormat

from kdoc.kdoc_files import KernelFiles

from kdoc.kdoc_output import RestFormat



__version__  = '1.0'

kfiles = None

scripts/kernel-doc.py

+3 −3
Original line number Diff line number Diff line
@@ -111,7 +111,7 @@ import sys 


# Import Python modules



LIB_DIR = "../tools/lib/python/kdoc"

LIB_DIR = "../tools/lib/python"

SRC_DIR = os.path.dirname(os.path.realpath(__file__))



sys.path.insert(0, os.path.join(SRC_DIR, LIB_DIR))
@@ -292,8 +292,8 @@ def main(): 
        logger.warning("Python 3.7 or later is required for correct results")



    # Import kernel-doc libraries only after checking Python version

    from kdoc_files import KernelFiles                  # pylint: disable=C0415

    from kdoc_output import RestFormat, ManFormat       # pylint: disable=C0415

    from kdoc.kdoc_files import KernelFiles             # pylint: disable=C0415

    from kdoc.kdoc_output import RestFormat, ManFormat  # pylint: disable=C0415



    if args.man:

        out_style = ManFormat(modulename=args.modulename)

tools/docs/check-variable-fonts.py

+2 −2
Original line number Diff line number Diff line
@@ -17,9 +17,9 @@ import sys 
import os.path



src_dir = os.path.dirname(os.path.realpath(__file__))

sys.path.insert(0, os.path.join(src_dir, '../lib/python/kdoc'))

sys.path.insert(0, os.path.join(src_dir, '../lib/python'))



from latex_fonts import LatexFontChecker

from kdoc.latex_fonts import LatexFontChecker



checker = LatexFontChecker()