[PATCH v3 1/2] scripts: fix all issues reported by pylint

[PATCH v3 1/2] scripts: fix all issues reported by pylint

[Dongliang Mu]

This patch 1) fixes all the issues (not most) reported by pylint,
2) add the functionability to tackle documents that need translation,
3) add logging to adjust the logging level and log file

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
---
 scripts/checktransupdate.py | 214 ++++++++++++++++++++++++------------
 1 file changed, 141 insertions(+), 73 deletions(-)

diff --git a/scripts/checktransupdate.py b/scripts/checktransupdate.py
index 5a0fc99e3f93..578c3fecfdfd 100755
--- a/scripts/checktransupdate.py
+++ b/scripts/checktransupdate.py
@@ -10,31 +10,28 @@ differences occur, report the file and commits that need to be updated.
 
 The usage is as follows:
 - ./scripts/checktransupdate.py -l zh_CN
-This will print all the files that need to be updated in the zh_CN locale.
+This will print all the files that need to be updated or translated in the zh_CN locale.
 - ./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst
 This will only print the status of the specified file.
 
 The output is something like:
-Documentation/translations/zh_CN/dev-tools/testing-overview.rst (1 commits)
+Documentation/dev-tools/kfence.rst
+No translation in the locale of zh_CN
+
+Documentation/translations/zh_CN/dev-tools/testing-overview.rst
 commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
+1 commits needs resolving in total
 """
 
 import os
-from argparse import ArgumentParser, BooleanOptionalAction
+import time
+import logging
+from argparse import ArgumentParser, ArgumentTypeError, BooleanOptionalAction
 from datetime import datetime
 
-flag_p_c = False
-flag_p_uf = False
-flag_debug = False
-
-
-def dprint(*args, **kwargs):
-    if flag_debug:
-        print("[DEBUG] ", end="")
-        print(*args, **kwargs)
-
 
 def get_origin_path(file_path):
+    """Get the origin path from the translation path"""
     paths = file_path.split("/")
     tidx = paths.index("translations")
     opaths = paths[:tidx]
@@ -43,17 +40,16 @@ def get_origin_path(file_path):
 
 
 def get_latest_commit_from(file_path, commit):
-    command = "git log --pretty=format:%H%n%aD%n%cD%n%n%B {} -1 -- {}".format(
-        commit, file_path
-    )
-    dprint(command)
+    """Get the latest commit from the specified commit for the specified file"""
+    command = f"git log --pretty=format:%H%n%aD%n%cD%n%n%B {commit} -1 -- {file_path}"
+    logging.debug(command)
     pipe = os.popen(command)
     result = pipe.read()
     result = result.split("\n")
     if len(result) <= 1:
         return None
 
-    dprint("Result: {}".format(result[0]))
+    logging.debug("Result: %s", result[0])
 
     return {
         "hash": result[0],
@@ -64,17 +60,19 @@ def get_latest_commit_from(file_path, commit):
 
 
 def get_origin_from_trans(origin_path, t_from_head):
+    """Get the latest origin commit from the translation commit"""
     o_from_t = get_latest_commit_from(origin_path, t_from_head["hash"])
     while o_from_t is not None and o_from_t["author_date"] > t_from_head["author_date"]:
         o_from_t = get_latest_commit_from(origin_path, o_from_t["hash"] + "^")
     if o_from_t is not None:
-        dprint("tracked origin commit id: {}".format(o_from_t["hash"]))
+        logging.debug("tracked origin commit id: %s", o_from_t["hash"])
     return o_from_t
 
 
 def get_commits_count_between(opath, commit1, commit2):
-    command = "git log --pretty=format:%H {}...{} -- {}".format(commit1, commit2, opath)
-    dprint(command)
+    """Get the commits count between two commits for the specified file"""
+    command = f"git log --pretty=format:%H {commit1}...{commit2} -- {opath}"
+    logging.debug(command)
     pipe = os.popen(command)
     result = pipe.read().split("\n")
     # filter out empty lines
@@ -83,50 +81,120 @@ def get_commits_count_between(opath, commit1, commit2):
 
 
 def pretty_output(commit):
-    command = "git log --pretty='format:%h (\"%s\")' -1 {}".format(commit)
-    dprint(command)
+    """Pretty print the commit message"""
+    command = f"git log --pretty='format:%h (\"%s\")' -1 {commit}"
+    logging.debug(command)
     pipe = os.popen(command)
     return pipe.read()
 
 
+def valid_commit(commit):
+    """Check if the commit is valid or not"""
+    msg = pretty_output(commit)
+    return "Merge tag" not in msg
+
 def check_per_file(file_path):
+    """Check the translation status for the specified file"""
     opath = get_origin_path(file_path)
 
     if not os.path.isfile(opath):
-        dprint("Error: Cannot find the origin path for {}".format(file_path))
+        logging.error("Cannot find the origin path for {file_path}")
         return
 
     o_from_head = get_latest_commit_from(opath, "HEAD")
     t_from_head = get_latest_commit_from(file_path, "HEAD")
 
     if o_from_head is None or t_from_head is None:
-        print("Error: Cannot find the latest commit for {}".format(file_path))
+        logging.error("Cannot find the latest commit for %s", file_path)
         return
 
     o_from_t = get_origin_from_trans(opath, t_from_head)
 
     if o_from_t is None:
-        print("Error: Cannot find the latest origin commit for {}".format(file_path))
+        logging.error("Error: Cannot find the latest origin commit for %s", file_path)
         return
 
     if o_from_head["hash"] == o_from_t["hash"]:
-        if flag_p_uf:
-            print("No update needed for {}".format(file_path))
-        return
+        logging.debug("No update needed for %s", file_path)
     else:
-        print("{}".format(file_path), end="\t")
+        logging.info(file_path)
         commits = get_commits_count_between(
             opath, o_from_t["hash"], o_from_head["hash"]
         )
-        print("({} commits)".format(len(commits)))
-        if flag_p_c:
-            for commit in commits:
-                msg = pretty_output(commit)
-                if "Merge tag" not in msg:
-                    print("commit", msg)
+        count = 0
+        for commit in commits:
+            if valid_commit(commit):
+                logging.info("commit %s", pretty_output(commit))
+                count += 1
+        logging.info("%d commits needs resolving in total\n", count)
+
+
+def valid_locales(locale):
+    """Check if the locale is valid or not"""
+    script_path = os.path.dirname(os.path.abspath(__file__))
+    linux_path = os.path.join(script_path, "..")
+    if not os.path.isdir(f"{linux_path}/Documentation/translations/{locale}"):
+        raise ArgumentTypeError("Invalid locale: {locale}")
+    return locale
+
+
+def list_files_with_excluding_folders(folder, exclude_folders, include_suffix):
+    """List all files with the specified suffix in the folder and its subfolders"""
+    files = []
+    stack = [folder]
+
+    while stack:
+        pwd = stack.pop()
+        # filter out the exclude folders
+        if os.path.basename(pwd) in exclude_folders:
+            continue
+        # list all files and folders
+        for item in os.listdir(pwd):
+            ab_item = os.path.join(pwd, item)
+            if os.path.isdir(ab_item):
+                stack.append(ab_item)
+            else:
+                if ab_item.endswith(include_suffix):
+                    files.append(ab_item)
+
+    return files
+
+
+class DmesgFormatter(logging.Formatter):
+    """Custom dmesg logging formatter"""
+    def format(self, record):
+        timestamp = time.time()
+        formatted_time = f"[{timestamp:>10.6f}]"
+        log_message = f"{formatted_time} {record.getMessage()}"
+        return log_message
+
+
+def config_logging(log_level, log_file="checktransupdate.log"):
+    """configure logging based on the log level"""
+    # set up the root logger
+    logger = logging.getLogger()
+    logger.setLevel(log_level)
+
+    # Create console handler
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(log_level)
+
+    # Create file handler
+    file_handler = logging.FileHandler(log_file)
+    file_handler.setLevel(log_level)
+
+    # Create formatter and add it to the handlers
+    formatter = DmesgFormatter()
+    console_handler.setFormatter(formatter)
+    file_handler.setFormatter(formatter)
+
+    # Add the handler to the logger
+    logger.addHandler(console_handler)
+    logger.addHandler(file_handler)
 
 
 def main():
+    """Main function of the script"""
     script_path = os.path.dirname(os.path.abspath(__file__))
     linux_path = os.path.join(script_path, "..")
 
@@ -134,62 +202,62 @@ def main():
     parser.add_argument(
         "-l",
         "--locale",
+        default="zh_CN",
+        type=valid_locales,
         help="Locale to check when files are not specified",
     )
+
     parser.add_argument(
-        "--print-commits",
+        "--print-missing-translations",
         action=BooleanOptionalAction,
         default=True,
-        help="Print commits between the origin and the translation",
+        help="Print files that do not have translations",
     )
 
     parser.add_argument(
-        "--print-updated-files",
-        action=BooleanOptionalAction,
-        default=False,
-        help="Print files that do no need to be updated",
-    )
+        '--log',
+        default='INFO',
+        choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
+        help='Set the logging level')
 
     parser.add_argument(
-        "--debug",
-        action=BooleanOptionalAction,
-        help="Print debug information",
-        default=False,
-    )
+        '--logfile',
+        default='checktransupdate.log',
+        help='Set the logging file (default: checktransupdate.log)')
 
     parser.add_argument(
         "files", nargs="*", help="Files to check, if not specified, check all files"
     )
     args = parser.parse_args()
 
-    global flag_p_c, flag_p_uf, flag_debug
-    flag_p_c = args.print_commits
-    flag_p_uf = args.print_updated_files
-    flag_debug = args.debug
+    # Configure logging based on the --log argument
+    log_level = getattr(logging, args.log.upper(), logging.INFO)
+    config_logging(log_level)
 
-    # get files related to linux path
+    # Get files related to linux path
     files = args.files
     if len(files) == 0:
-        if args.locale is not None:
-            files = (
-                os.popen(
-                    "find {}/Documentation/translations/{} -type f".format(
-                        linux_path, args.locale
-                    )
-                )
-                .read()
-                .split("\n")
-            )
-        else:
-            files = (
-                os.popen(
-                    "find {}/Documentation/translations -type f".format(linux_path)
-                )
-                .read()
-                .split("\n")
-            )
-
-    files = list(filter(lambda x: x != "", files))
+        offical_files = list_files_with_excluding_folders(
+            os.path.join(linux_path, "Documentation"), ["translations", "output"], "rst"
+        )
+
+        for file in offical_files:
+            # split the path into parts
+            path_parts = file.split(os.sep)
+            # find the index of the "Documentation" directory
+            kindex = path_parts.index("Documentation")
+            # insert the translations and locale after the Documentation directory
+            new_path_parts = path_parts[:kindex + 1] + ["translations", args.locale] \
+                           + path_parts[kindex + 1 :]
+            # join the path parts back together
+            new_file = os.sep.join(new_path_parts)
+            if os.path.isfile(new_file):
+                files.append(new_file)
+            else:
+                if args.print_missing_translations:
+                    logging.info(os.path.relpath(os.path.abspath(file), linux_path))
+                    logging.info("No translation in the locale of %s\n", args.locale)
+
     files = list(map(lambda x: os.path.relpath(os.path.abspath(x), linux_path), files))
 
     # cd to linux root directory
-- 
2.43.0

Re: [PATCH v3 1/2] scripts: fix all issues reported by pylint

[Yanteng Si]

在 2024/7/19 12:13, Dongliang Mu 写道:
> This patch 1) fixes all the issues (not most) reported by pylint,
> 2) add the functionability to tackle documents that need translation,
> 3) add logging to adjust the logging level and log file
>
> Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>

Reviewed-by: Yanteng Si <siyanteng@loongson.cn>


Thanks,

Yanteng

> ---
>   scripts/checktransupdate.py | 214 ++++++++++++++++++++++++------------
>   1 file changed, 141 insertions(+), 73 deletions(-)
>
> diff --git a/scripts/checktransupdate.py b/scripts/checktransupdate.py
> index 5a0fc99e3f93..578c3fecfdfd 100755
> --- a/scripts/checktransupdate.py
> +++ b/scripts/checktransupdate.py
> @@ -10,31 +10,28 @@ differences occur, report the file and commits that need to be updated.
>   
>   The usage is as follows:
>   - ./scripts/checktransupdate.py -l zh_CN
> -This will print all the files that need to be updated in the zh_CN locale.
> +This will print all the files that need to be updated or translated in the zh_CN locale.
>   - ./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst
>   This will only print the status of the specified file.
>   
>   The output is something like:
> -Documentation/translations/zh_CN/dev-tools/testing-overview.rst (1 commits)
> +Documentation/dev-tools/kfence.rst
> +No translation in the locale of zh_CN
> +
> +Documentation/translations/zh_CN/dev-tools/testing-overview.rst
>   commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
> +1 commits needs resolving in total
>   """
>   
>   import os
> -from argparse import ArgumentParser, BooleanOptionalAction
> +import time
> +import logging
> +from argparse import ArgumentParser, ArgumentTypeError, BooleanOptionalAction
>   from datetime import datetime
>   
> -flag_p_c = False
> -flag_p_uf = False
> -flag_debug = False
> -
> -
> -def dprint(*args, **kwargs):
> -    if flag_debug:
> -        print("[DEBUG] ", end="")
> -        print(*args, **kwargs)
> -
>   
>   def get_origin_path(file_path):
> +    """Get the origin path from the translation path"""
>       paths = file_path.split("/")
>       tidx = paths.index("translations")
>       opaths = paths[:tidx]
> @@ -43,17 +40,16 @@ def get_origin_path(file_path):
>   
>   
>   def get_latest_commit_from(file_path, commit):
> -    command = "git log --pretty=format:%H%n%aD%n%cD%n%n%B {} -1 -- {}".format(
> -        commit, file_path
> -    )
> -    dprint(command)
> +    """Get the latest commit from the specified commit for the specified file"""
> +    command = f"git log --pretty=format:%H%n%aD%n%cD%n%n%B {commit} -1 -- {file_path}"
> +    logging.debug(command)
>       pipe = os.popen(command)
>       result = pipe.read()
>       result = result.split("\n")
>       if len(result) <= 1:
>           return None
>   
> -    dprint("Result: {}".format(result[0]))
> +    logging.debug("Result: %s", result[0])
>   
>       return {
>           "hash": result[0],
> @@ -64,17 +60,19 @@ def get_latest_commit_from(file_path, commit):
>   
>   
>   def get_origin_from_trans(origin_path, t_from_head):
> +    """Get the latest origin commit from the translation commit"""
>       o_from_t = get_latest_commit_from(origin_path, t_from_head["hash"])
>       while o_from_t is not None and o_from_t["author_date"] > t_from_head["author_date"]:
>           o_from_t = get_latest_commit_from(origin_path, o_from_t["hash"] + "^")
>       if o_from_t is not None:
> -        dprint("tracked origin commit id: {}".format(o_from_t["hash"]))
> +        logging.debug("tracked origin commit id: %s", o_from_t["hash"])
>       return o_from_t
>   
>   
>   def get_commits_count_between(opath, commit1, commit2):
> -    command = "git log --pretty=format:%H {}...{} -- {}".format(commit1, commit2, opath)
> -    dprint(command)
> +    """Get the commits count between two commits for the specified file"""
> +    command = f"git log --pretty=format:%H {commit1}...{commit2} -- {opath}"
> +    logging.debug(command)
>       pipe = os.popen(command)
>       result = pipe.read().split("\n")
>       # filter out empty lines
> @@ -83,50 +81,120 @@ def get_commits_count_between(opath, commit1, commit2):
>   
>   
>   def pretty_output(commit):
> -    command = "git log --pretty='format:%h (\"%s\")' -1 {}".format(commit)
> -    dprint(command)
> +    """Pretty print the commit message"""
> +    command = f"git log --pretty='format:%h (\"%s\")' -1 {commit}"
> +    logging.debug(command)
>       pipe = os.popen(command)
>       return pipe.read()
>   
>   
> +def valid_commit(commit):
> +    """Check if the commit is valid or not"""
> +    msg = pretty_output(commit)
> +    return "Merge tag" not in msg
> +
>   def check_per_file(file_path):
> +    """Check the translation status for the specified file"""
>       opath = get_origin_path(file_path)
>   
>       if not os.path.isfile(opath):
> -        dprint("Error: Cannot find the origin path for {}".format(file_path))
> +        logging.error("Cannot find the origin path for {file_path}")
>           return
>   
>       o_from_head = get_latest_commit_from(opath, "HEAD")
>       t_from_head = get_latest_commit_from(file_path, "HEAD")
>   
>       if o_from_head is None or t_from_head is None:
> -        print("Error: Cannot find the latest commit for {}".format(file_path))
> +        logging.error("Cannot find the latest commit for %s", file_path)
>           return
>   
>       o_from_t = get_origin_from_trans(opath, t_from_head)
>   
>       if o_from_t is None:
> -        print("Error: Cannot find the latest origin commit for {}".format(file_path))
> +        logging.error("Error: Cannot find the latest origin commit for %s", file_path)
>           return
>   
>       if o_from_head["hash"] == o_from_t["hash"]:
> -        if flag_p_uf:
> -            print("No update needed for {}".format(file_path))
> -        return
> +        logging.debug("No update needed for %s", file_path)
>       else:
> -        print("{}".format(file_path), end="\t")
> +        logging.info(file_path)
>           commits = get_commits_count_between(
>               opath, o_from_t["hash"], o_from_head["hash"]
>           )
> -        print("({} commits)".format(len(commits)))
> -        if flag_p_c:
> -            for commit in commits:
> -                msg = pretty_output(commit)
> -                if "Merge tag" not in msg:
> -                    print("commit", msg)
> +        count = 0
> +        for commit in commits:
> +            if valid_commit(commit):
> +                logging.info("commit %s", pretty_output(commit))
> +                count += 1
> +        logging.info("%d commits needs resolving in total\n", count)
> +
> +
> +def valid_locales(locale):
> +    """Check if the locale is valid or not"""
> +    script_path = os.path.dirname(os.path.abspath(__file__))
> +    linux_path = os.path.join(script_path, "..")
> +    if not os.path.isdir(f"{linux_path}/Documentation/translations/{locale}"):
> +        raise ArgumentTypeError("Invalid locale: {locale}")
> +    return locale
> +
> +
> +def list_files_with_excluding_folders(folder, exclude_folders, include_suffix):
> +    """List all files with the specified suffix in the folder and its subfolders"""
> +    files = []
> +    stack = [folder]
> +
> +    while stack:
> +        pwd = stack.pop()
> +        # filter out the exclude folders
> +        if os.path.basename(pwd) in exclude_folders:
> +            continue
> +        # list all files and folders
> +        for item in os.listdir(pwd):
> +            ab_item = os.path.join(pwd, item)
> +            if os.path.isdir(ab_item):
> +                stack.append(ab_item)
> +            else:
> +                if ab_item.endswith(include_suffix):
> +                    files.append(ab_item)
> +
> +    return files
> +
> +
> +class DmesgFormatter(logging.Formatter):
> +    """Custom dmesg logging formatter"""
> +    def format(self, record):
> +        timestamp = time.time()
> +        formatted_time = f"[{timestamp:>10.6f}]"
> +        log_message = f"{formatted_time} {record.getMessage()}"
> +        return log_message
> +
> +
> +def config_logging(log_level, log_file="checktransupdate.log"):
> +    """configure logging based on the log level"""
> +    # set up the root logger
> +    logger = logging.getLogger()
> +    logger.setLevel(log_level)
> +
> +    # Create console handler
> +    console_handler = logging.StreamHandler()
> +    console_handler.setLevel(log_level)
> +
> +    # Create file handler
> +    file_handler = logging.FileHandler(log_file)
> +    file_handler.setLevel(log_level)
> +
> +    # Create formatter and add it to the handlers
> +    formatter = DmesgFormatter()
> +    console_handler.setFormatter(formatter)
> +    file_handler.setFormatter(formatter)
> +
> +    # Add the handler to the logger
> +    logger.addHandler(console_handler)
> +    logger.addHandler(file_handler)
>   
>   
>   def main():
> +    """Main function of the script"""
>       script_path = os.path.dirname(os.path.abspath(__file__))
>       linux_path = os.path.join(script_path, "..")
>   
> @@ -134,62 +202,62 @@ def main():
>       parser.add_argument(
>           "-l",
>           "--locale",
> +        default="zh_CN",
> +        type=valid_locales,
>           help="Locale to check when files are not specified",
>       )
> +
>       parser.add_argument(
> -        "--print-commits",
> +        "--print-missing-translations",
>           action=BooleanOptionalAction,
>           default=True,
> -        help="Print commits between the origin and the translation",
> +        help="Print files that do not have translations",
>       )
>   
>       parser.add_argument(
> -        "--print-updated-files",
> -        action=BooleanOptionalAction,
> -        default=False,
> -        help="Print files that do no need to be updated",
> -    )
> +        '--log',
> +        default='INFO',
> +        choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
> +        help='Set the logging level')
>   
>       parser.add_argument(
> -        "--debug",
> -        action=BooleanOptionalAction,
> -        help="Print debug information",
> -        default=False,
> -    )
> +        '--logfile',
> +        default='checktransupdate.log',
> +        help='Set the logging file (default: checktransupdate.log)')
>   
>       parser.add_argument(
>           "files", nargs="*", help="Files to check, if not specified, check all files"
>       )
>       args = parser.parse_args()
>   
> -    global flag_p_c, flag_p_uf, flag_debug
> -    flag_p_c = args.print_commits
> -    flag_p_uf = args.print_updated_files
> -    flag_debug = args.debug
> +    # Configure logging based on the --log argument
> +    log_level = getattr(logging, args.log.upper(), logging.INFO)
> +    config_logging(log_level)
>   
> -    # get files related to linux path
> +    # Get files related to linux path
>       files = args.files
>       if len(files) == 0:
> -        if args.locale is not None:
> -            files = (
> -                os.popen(
> -                    "find {}/Documentation/translations/{} -type f".format(
> -                        linux_path, args.locale
> -                    )
> -                )
> -                .read()
> -                .split("\n")
> -            )
> -        else:
> -            files = (
> -                os.popen(
> -                    "find {}/Documentation/translations -type f".format(linux_path)
> -                )
> -                .read()
> -                .split("\n")
> -            )
> -
> -    files = list(filter(lambda x: x != "", files))
> +        offical_files = list_files_with_excluding_folders(
> +            os.path.join(linux_path, "Documentation"), ["translations", "output"], "rst"
> +        )
> +
> +        for file in offical_files:
> +            # split the path into parts
> +            path_parts = file.split(os.sep)
> +            # find the index of the "Documentation" directory
> +            kindex = path_parts.index("Documentation")
> +            # insert the translations and locale after the Documentation directory
> +            new_path_parts = path_parts[:kindex + 1] + ["translations", args.locale] \
> +                           + path_parts[kindex + 1 :]
> +            # join the path parts back together
> +            new_file = os.sep.join(new_path_parts)
> +            if os.path.isfile(new_file):
> +                files.append(new_file)
> +            else:
> +                if args.print_missing_translations:
> +                    logging.info(os.path.relpath(os.path.abspath(file), linux_path))
> +                    logging.info("No translation in the locale of %s\n", args.locale)
> +
>       files = list(map(lambda x: os.path.relpath(os.path.abspath(x), linux_path), files))
>   
>       # cd to linux root directory

[PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Dongliang Mu]

This commit adds help documents - doc-guide/checktransupdate.rst
and zh_CN/doc-guide/checktransupdate.rst for scripts/checktransupdate.py
, including English and Chinese versions

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
---
 Documentation/doc-guide/checktransupdate.rst  | 53 ++++++++++++++++++
 Documentation/doc-guide/index.rst             |  1 +
 .../zh_CN/doc-guide/checktransupdate.rst      | 55 +++++++++++++++++++
 .../translations/zh_CN/doc-guide/index.rst    |  1 +
 4 files changed, 110 insertions(+)
 create mode 100644 Documentation/doc-guide/checktransupdate.rst
 create mode 100644 Documentation/translations/zh_CN/doc-guide/checktransupdate.rst

diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
new file mode 100644
index 000000000000..dabbf9ecd187
--- /dev/null
+++ b/Documentation/doc-guide/checktransupdate.rst
@@ -0,0 +1,53 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Check translation update
+
+This script helps track the translation status of the documentation in
+different locales, i.e., whether the documentation is up-to-date with
+the English counterpart.
+
+How it works
+------------
+
+It uses ``git log`` command to track the latest English commit from the
+translation commit (order by author date) and the latest English commits
+from HEAD. If any differences occur, the file is considered as out-of-date,
+then commits that need to be updated will be collected and reported.
+
+Features implemented
+
+-  check all files in a certain locale
+-  check a single file or a set of files
+-  provide options to change output format
+-  track the translation status of files that have no translation
+
+Usage
+-----
+
+::
+
+   ./scripts/checktransupdate.py --help
+
+Please refer to the output of argument parser for usage details.
+
+Samples
+
+-  ``./scripts/checktransupdate.py -l zh_CN``
+   This will print all the files that need to be updated in the zh_CN locale.
+-  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
+   This will only print the status of the specified file.
+
+Then the output is something like:
+
+::
+
+    Documentation/dev-tools/kfence.rst
+    No translation in the locale of zh_CN
+
+    Documentation/translations/zh_CN/dev-tools/testing-overview.rst
+    commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
+    1 commits needs resolving in total
+
+Features to be implemented
+
+- files can be a folder instead of only a file
diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
index 7c7d97784626..24d058faa75c 100644
--- a/Documentation/doc-guide/index.rst
+++ b/Documentation/doc-guide/index.rst
@@ -12,6 +12,7 @@ How to write kernel documentation
    parse-headers
    contributing
    maintainer-profile
+   checktransupdate
 
 .. only::  subproject and html
 
diff --git a/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst
new file mode 100644
index 000000000000..d20b4ce66b9f
--- /dev/null
+++ b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst
@@ -0,0 +1,55 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: ../disclaimer-zh_CN.rst
+
+:Original: Documentation/doc-guide/checktransupdate.rst
+
+:译者: 慕冬亮 Dongliang Mu <dzm91@hust.edu.cn>
+
+检查翻译更新
+
+这个脚本帮助跟踪不同语言的文档翻译状态，即文档是否与对应的英文版本保持更新。
+
+工作原理
+------------
+
+它使用 ``git log`` 命令来跟踪翻译提交的最新英文提交（按作者日期排序）和英文文档的
+最新提交。如果有任何差异，则该文件被认为是过期的，然后需要更新的提交将被收集并报告。
+
+实现的功能
+
+- 检查特定语言中的所有文件
+- 检查单个文件或一组文件
+- 提供更改输出格式的选项
+- 跟踪没有翻译过的文件的翻译状态
+
+用法
+-----
+
+::
+
+    ./scripts/checktransupdate.py --help
+
+具体用法请参考参数解析器的输出
+
+示例
+
+-  ``./scripts/checktransupdate.py -l zh_CN``
+   这将打印 zh_CN 语言中需要更新的所有文件。
+-  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
+   这将只打印指定文件的状态。
+
+然后输出类似如下的内容：
+
+::
+
+    Documentation/dev-tools/kfence.rst
+    No translation in the locale of zh_CN
+
+    Documentation/translations/zh_CN/dev-tools/testing-overview.rst
+    commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
+    1 commits needs resolving in total
+
+待实现的功能
+
+- 文件参数可以是文件夹而不仅仅是单个文件
diff --git a/Documentation/translations/zh_CN/doc-guide/index.rst b/Documentation/translations/zh_CN/doc-guide/index.rst
index 78c2e9a1697f..0ac1fc9315ea 100644
--- a/Documentation/translations/zh_CN/doc-guide/index.rst
+++ b/Documentation/translations/zh_CN/doc-guide/index.rst
@@ -18,6 +18,7 @@
    parse-headers
    contributing
    maintainer-profile
+   checktransupdate
 
 .. only::  subproject and html
 
-- 
2.43.0

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Yanteng Si]

在 2024/7/19 12:13, Dongliang Mu 写道:
> This commit adds help documents - doc-guide/checktransupdate.rst
> and zh_CN/doc-guide/checktransupdate.rst for scripts/checktransupdate.py
> , including English and Chinese versions
>
> Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>


Thanks,

Yanteng
> ---
>   Documentation/doc-guide/checktransupdate.rst  | 53 ++++++++++++++++++
>   Documentation/doc-guide/index.rst             |  1 +
>   .../zh_CN/doc-guide/checktransupdate.rst      | 55 +++++++++++++++++++
>   .../translations/zh_CN/doc-guide/index.rst    |  1 +
>   4 files changed, 110 insertions(+)
>   create mode 100644 Documentation/doc-guide/checktransupdate.rst
>   create mode 100644 Documentation/translations/zh_CN/doc-guide/checktransupdate.rst
>
> diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> new file mode 100644
> index 000000000000..dabbf9ecd187
> --- /dev/null
> +++ b/Documentation/doc-guide/checktransupdate.rst
> @@ -0,0 +1,53 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Check translation update
> +
> +This script helps track the translation status of the documentation in
> +different locales, i.e., whether the documentation is up-to-date with
> +the English counterpart.
> +
> +How it works
> +------------
> +
> +It uses ``git log`` command to track the latest English commit from the
> +translation commit (order by author date) and the latest English commits
> +from HEAD. If any differences occur, the file is considered as out-of-date,
> +then commits that need to be updated will be collected and reported.
> +
> +Features implemented
> +
> +-  check all files in a certain locale
> +-  check a single file or a set of files
> +-  provide options to change output format
> +-  track the translation status of files that have no translation
> +
> +Usage
> +-----
> +
> +::
> +
> +   ./scripts/checktransupdate.py --help
> +
> +Please refer to the output of argument parser for usage details.
> +
> +Samples
> +
> +-  ``./scripts/checktransupdate.py -l zh_CN``
> +   This will print all the files that need to be updated in the zh_CN locale.
> +-  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
> +   This will only print the status of the specified file.
> +
> +Then the output is something like:
> +
> +::
> +
> +    Documentation/dev-tools/kfence.rst
> +    No translation in the locale of zh_CN
> +
> +    Documentation/translations/zh_CN/dev-tools/testing-overview.rst
> +    commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
> +    1 commits needs resolving in total
> +
> +Features to be implemented
> +
> +- files can be a folder instead of only a file
> diff --git a/Documentation/doc-guide/index.rst b/Documentation/doc-guide/index.rst
> index 7c7d97784626..24d058faa75c 100644
> --- a/Documentation/doc-guide/index.rst
> +++ b/Documentation/doc-guide/index.rst
> @@ -12,6 +12,7 @@ How to write kernel documentation
>      parse-headers
>      contributing
>      maintainer-profile
> +   checktransupdate
>   
>   .. only::  subproject and html
>   
> diff --git a/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst
> new file mode 100644
> index 000000000000..d20b4ce66b9f
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/doc-guide/checktransupdate.rst
> @@ -0,0 +1,55 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/doc-guide/checktransupdate.rst
> +
> +:译者: 慕冬亮 Dongliang Mu <dzm91@hust.edu.cn>
> +
> +检查翻译更新
> +
> +这个脚本帮助跟踪不同语言的文档翻译状态，即文档是否与对应的英文版本保持更新。
> +
> +工作原理
> +------------
> +
> +它使用 ``git log`` 命令来跟踪翻译提交的最新英文提交（按作者日期排序）和英文文档的
> +最新提交。如果有任何差异，则该文件被认为是过期的，然后需要更新的提交将被收集并报告。
> +
> +实现的功能
> +
> +- 检查特定语言中的所有文件
> +- 检查单个文件或一组文件
> +- 提供更改输出格式的选项
> +- 跟踪没有翻译过的文件的翻译状态
> +
> +用法
> +-----
> +
> +::
> +
> +    ./scripts/checktransupdate.py --help
> +
> +具体用法请参考参数解析器的输出
> +
> +示例
> +
> +-  ``./scripts/checktransupdate.py -l zh_CN``
> +   这将打印 zh_CN 语言中需要更新的所有文件。
> +-  ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
> +   这将只打印指定文件的状态。
> +
> +然后输出类似如下的内容：
> +
> +::
> +
> +    Documentation/dev-tools/kfence.rst
> +    No translation in the locale of zh_CN
> +
> +    Documentation/translations/zh_CN/dev-tools/testing-overview.rst
> +    commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
> +    1 commits needs resolving in total
> +
> +待实现的功能
> +
> +- 文件参数可以是文件夹而不仅仅是单个文件
> diff --git a/Documentation/translations/zh_CN/doc-guide/index.rst b/Documentation/translations/zh_CN/doc-guide/index.rst
> index 78c2e9a1697f..0ac1fc9315ea 100644
> --- a/Documentation/translations/zh_CN/doc-guide/index.rst
> +++ b/Documentation/translations/zh_CN/doc-guide/index.rst
> @@ -18,6 +18,7 @@
>      parse-headers
>      contributing
>      maintainer-profile
> +   checktransupdate
>   
>   .. only::  subproject and html
>   

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Jonathan Corbet]

For future reference, a sequence like this:

> +Then the output is something like:
> +
> +::
> +
> +    Documentation/dev-tools/kfence.rst

Can be more concisely and legibly expressed as:

> Then the output is something like::
>
>    (literal text here)

More importantly, though, this file:

> diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> new file mode 100644
> index 000000000000..dabbf9ecd187
> --- /dev/null
> +++ b/Documentation/doc-guide/checktransupdate.rst
> @@ -0,0 +1,53 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Check translation update
> +
> +This script helps track the translation status of the documentation in
> +different locales, i.e., whether the documentation is up-to-date with
> +the English counterpart.

...lacks a title, so it renders strangely and inserts inscrutable stuff
into the doc-guide index.  I have fixed this, but I am not entirely
happy about that; this is a problem you should have seen immediately by
looking at the rendered version of your new document.  *Please* be a bit
more careful in the future.

Both patches applied, anyway.

jon

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Dongliang Mu]

On Tue, Jul 30, 2024 at 5:44 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> For future reference, a sequence like this:
>
> > +Then the output is something like:
> > +
> > +::
> > +
> > +    Documentation/dev-tools/kfence.rst
>
> Can be more concisely and legibly expressed as:
>
> > Then the output is something like::
> >
> >    (literal text here)
>
> More importantly, though, this file:
>
> > diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> > new file mode 100644
> > index 000000000000..dabbf9ecd187
> > --- /dev/null
> > +++ b/Documentation/doc-guide/checktransupdate.rst
> > @@ -0,0 +1,53 @@
> > +.. SPDX-License-Identifier: GPL-2.0
> > +
> > +Check translation update
> > +
> > +This script helps track the translation status of the documentation in
> > +different locales, i.e., whether the documentation is up-to-date with
> > +the English counterpart.
>
> ...lacks a title, so it renders strangely and inserts inscrutable stuff
> into the doc-guide index.  I have fixed this, but I am not entirely
> happy about that; this is a problem you should have seen immediately by
> looking at the rendered version of your new document.  *Please* be a bit
> more careful in the future.

Hi jon,

If I understand correctly, you mean there should be "==========" under
the sentence "Check translate update". This would generate a title,
right?

Unfortunately, the "==========" is asked to be deleted in the v2
patch. I doubted it, but did not make it back.

BTW, the merged commit version has the title - "How it works", other
than "Check translate update".

Please correct me if I make any misunderstanding.




>
> Both patches applied, anyway.
>
> jon
>

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Jonathan Corbet]

Dongliang Mu <mudongliangabcd@gmail.com> writes:

>> ...lacks a title, so it renders strangely and inserts inscrutable stuff
>> into the doc-guide index.  I have fixed this, but I am not entirely
>> happy about that; this is a problem you should have seen immediately by
>> looking at the rendered version of your new document.  *Please* be a bit
>> more careful in the future.
>
> Hi jon,
>
> If I understand correctly, you mean there should be "==========" under
> the sentence "Check translate update". This would generate a title,
> right?
>
> Unfortunately, the "==========" is asked to be deleted in the v2
> patch. I doubted it, but did not make it back.

If somebody asked for that, they were wrong; I didn't see that.

> BTW, the merged commit version has the title - "How it works", other
> than "Check translate update".

That is just the problem I thought I had fixed; somehow my change got
lost on the way into git.  Oops.  I think maybe I'll just rebase the
tree and fix both of the problems at the source.

jon

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Dongliang Mu]

On Tue, Jul 30, 2024 at 5:44 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> For future reference, a sequence like this:
>
> > +Then the output is something like:
> > +
> > +::
> > +
> > +    Documentation/dev-tools/kfence.rst
>
> Can be more concisely and legibly expressed as:
>
> > Then the output is something like::
> >
> >    (literal text here)
>

Hi jon,

If I understand correctly, you mean to remove "::", right?

If yes, the rendered version looks very strange, e.g, the document -
Documentation/dev-tools/kfence.rst will be rendered as a file.


> More importantly, though, this file:
>
> > diff --git a/Documentation/doc-guide/checktransupdate.rst b/Documentation/doc-guide/checktransupdate.rst
> > new file mode 100644
> > index 000000000000..dabbf9ecd187
> > --- /dev/null
> > +++ b/Documentation/doc-guide/checktransupdate.rst
> > @@ -0,0 +1,53 @@
> > +.. SPDX-License-Identifier: GPL-2.0
> > +
> > +Check translation update
> > +
> > +This script helps track the translation status of the documentation in
> > +different locales, i.e., whether the documentation is up-to-date with
> > +the English counterpart.
>
> ...lacks a title, so it renders strangely and inserts inscrutable stuff
> into the doc-guide index.  I have fixed this, but I am not entirely
> happy about that; this is a problem you should have seen immediately by
> looking at the rendered version of your new document.  *Please* be a bit
> more careful in the future.
>
> Both patches applied, anyway.
>
> jon
>

Re: [PATCH v3 2/2] doc-guide: add help documentation checktransupdate.rst

[Jonathan Corbet]

Dongliang Mu <mudongliangabcd@gmail.com> writes:

>> > +Then the output is something like:
>> > +
>> > +::
>> > +
>> > +    Documentation/dev-tools/kfence.rst
>>
>> Can be more concisely and legibly expressed as:
>>
>> > Then the output is something like::
>> >
>> >    (literal text here)
>>
>
> Hi jon,
>
> If I understand correctly, you mean to remove "::", right?

No, not quite - note that the "::" appears at the end of the line above
the literal block.

jon