linux-kernel - Re: [PATCH v3 2/4] scripts/kernel-doc: avoid error

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] [day] [month] [year] [list]

Message-ID: <0eadb091-2a5c-402b-908a-7f069c115c9f@infradead.org>
Date: Tue, 13 Jan 2026 22:42:08 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 Linux Doc Mailing List <linux-doc@...r.kernel.org>,
 Mauro Carvalho Chehab <mchehab@...nel.org>
Cc: linux-kernel@...r.kernel.org, Jani Nikula <jani.nikula@...el.com>,
 Jonathan Corbet <corbet@....net>, Shuah Khan <skhan@...uxfoundation.org>,
 stable@...r.kernel.org
Subject: Re: [PATCH v3 2/4] scripts/kernel-doc: avoid error_count overflows



On 1/13/26 9:19 AM, Mauro Carvalho Chehab wrote:
> The glibc library limits the return code to 8 bits. We need to
> stick to this limit when using sys.exit(error_count).
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> Cc: stable@...r.kernel.org
> ---
>  scripts/kernel-doc.py | 26 +++++++++++++++++++-------
>  1 file changed, 19 insertions(+), 7 deletions(-)
> 
> diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py
> index 7a1eaf986bcd..5d2f29e90ebe 100755
> --- a/scripts/kernel-doc.py
> +++ b/scripts/kernel-doc.py
> @@ -116,6 +116,8 @@ SRC_DIR = os.path.dirname(os.path.realpath(__file__))
>  
>  sys.path.insert(0, os.path.join(SRC_DIR, LIB_DIR))
>  
> +WERROR_RETURN_CODE = 3
> +
>  DESC = """
>  Read C language source or header FILEs, extract embedded documentation comments,
>  and print formatted documentation to standard output.
> @@ -176,7 +178,21 @@ class MsgFormatter(logging.Formatter):
>          return logging.Formatter.format(self, record)
>  
>  def main():
> -    """Main program"""
> +    """
> +    Main program
> +    By default, the return value is:
> +
> +    - 0: parsing warnings or Python version is not compatible with
> +      kernel-doc. The rationale for the latter is to not break Linux
> +      compilation on such cases;

    Does "parsing warnings" mean that there were no errors, just possibly
    warnings or possibly nothing, i.e., all clean?

> +
> +    - 1: an abnormal condition happened;
> +
> +    - 2: arparse issued an error;

            argparse ?

> +
> +    - 3: -Werror is used, and one or more unfiltered parse warnings
> +         happened.
> +    """
>  
>      parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter,
>                                       description=DESC)
> @@ -323,16 +339,12 @@ def main():
>  
>      if args.werror:
>          print("%s warnings as errors" % error_count)    # pylint: disable=C0209
> -        sys.exit(error_count)
> +        sys.exit(WERROR_RETURN_CODE)
>  
>      if args.verbose:
>          print("%s errors" % error_count)                # pylint: disable=C0209
>  
> -    if args.none:
> -        sys.exit(0)
> -
> -    sys.exit(error_count)
> -
> +    sys.exit(0)
>  
>  # Call main method
>  if __name__ == "__main__":

-- 
~Randy