Commit bd28e997 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: kdoc: ensure that comments are using our coding style



Along kernel-doc libs, we opted to have all comments starting/ending
with a blank comment line. Use the same style here.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <50e430acd333a500719205e80ab3b2d297edcd7d.1768823489.git.mchehab+huawei@kernel.org>
parent 802774d8
Loading
Loading
Loading
Loading
+18 −6
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
# Copyright(c) 2025: Mauro Carvalho Chehab <mchehab@kernel.org>.
#
# pylint: disable=C0103,R0912,R0914,R0915

#
# NOTE: While kernel-doc requires at least version 3.6 to run, the
#       command line should work with Python 3.2+ (tested with 3.4).
#       The rationale is that it shall fail gracefully during Kernel
@@ -12,7 +12,7 @@
#       - no f-strings can be used on this file.
#       - the libraries that require newer versions can only be included
#         after Python version is checked.

#
# Converted from the kernel-doc script originally written in Perl
# under GPLv2, copyrighted since 1998 by the following authors:
#
@@ -197,8 +197,9 @@ def main():
    parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter,
                                     description=DESC)

    #
    # Normal arguments

    #
    parser.add_argument("-v", "-verbose", "--verbose", action="store_true",
                        help="Verbose output, more warnings and other information.")

@@ -213,8 +214,9 @@ def main():
                        action="store_true",
                        help="Enable line number output (only in ReST mode)")

    #
    # Arguments to control the warning behavior

    #
    parser.add_argument("-Wreturn", "--wreturn", action="store_true",
                        help="Warns about the lack of a return markup on functions.")

@@ -235,8 +237,9 @@ def main():
    parser.add_argument("-export-file", "--export-file", action='append',
                        help=EXPORT_FILE_DESC)

    #
    # Output format mutually-exclusive group

    #
    out_group = parser.add_argument_group("Output format selection (mutually exclusive)")

    out_fmt = out_group.add_mutually_exclusive_group()
@@ -248,8 +251,9 @@ def main():
    out_fmt.add_argument("-N", "-none", "--none", action="store_true",
                         help="Do not output documentation, only warnings.")

    #
    # Output selection mutually-exclusive group

    #
    sel_group = parser.add_argument_group("Output selection (mutually exclusive)")
    sel_mut = sel_group.add_mutually_exclusive_group()

@@ -262,7 +266,9 @@ def main():
    sel_mut.add_argument("-s", "-function", "--symbol", action='append',
                         help=FUNCTION_DESC)

    #
    # Those are valid for all 3 types of filter
    #
    parser.add_argument("-n", "-nosymbol", "--nosymbol", action='append',
                        help=NOSYMBOL_DESC)

@@ -295,9 +301,11 @@ def main():

    python_ver = sys.version_info[:2]
    if python_ver < (3,6):
        #
        # Depending on Kernel configuration, kernel-doc --none is called at
        # build time. As we don't want to break compilation due to the
        # usage of an old Python version, return 0 here.
        #
        if args.none:
            logger.error("Python 3.6 or later is required by kernel-doc. skipping checks")
            sys.exit(0)
@@ -307,7 +315,9 @@ def main():
    if python_ver < (3,7):
        logger.warning("Python 3.7 or later is required for correct results")

    #
    # Import kernel-doc libraries only after checking Python version
    #
    from kdoc.kdoc_files import KernelFiles             # pylint: disable=C0415
    from kdoc.kdoc_output import RestFormat, ManFormat  # pylint: disable=C0415

@@ -346,6 +356,8 @@ def main():

    sys.exit(0)

#
# Call main method
#
if __name__ == "__main__":
    main()