[clang] [clang-format] Add --strip-trailing-cr to diff in docs_updated.test (PR #119666)

via cfe-commits cfe-commits at lists.llvm.org
Wed Dec 11 23:21:08 PST 2024


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Owen Pan (owenca)

<details>
<summary>Changes</summary>

Also clean up dump_format_style.py and dump_format_help.py.

---
Full diff: https://github.com/llvm/llvm-project/pull/119666.diff


3 Files Affected:

- (modified) clang/docs/tools/dump_format_help.py (+4-2) 
- (modified) clang/docs/tools/dump_format_style.py (+6-4) 
- (modified) clang/test/Format/docs_updated.test (+3-2) 


``````````diff
diff --git a/clang/docs/tools/dump_format_help.py b/clang/docs/tools/dump_format_help.py
index baf90048ee1352..ba41ed8c02c817 100755
--- a/clang/docs/tools/dump_format_help.py
+++ b/clang/docs/tools/dump_format_help.py
@@ -72,5 +72,7 @@ def validate(text, columns):
 
 contents = substitute(contents, "FORMAT_HELP", help_text)
 
-with open(opts.output if opts.output else DOC_FILE, "wb") as output:
-    output.write(contents.encode())
+with open(
+    opts.output if opts.output else DOC_FILE, "w", newline="", encoding="utf-8"
+) as f:
+    f.write(contents)
diff --git a/clang/docs/tools/dump_format_style.py b/clang/docs/tools/dump_format_style.py
index f00f3ee8b20e87..f035143f6b3d14 100755
--- a/clang/docs/tools/dump_format_style.py
+++ b/clang/docs/tools/dump_format_style.py
@@ -411,8 +411,8 @@ class State:
                     state = State.InStruct
                     enums[enum.name] = enum
                 else:
-                    # Enum member without documentation. Must be documented where the enum
-                    # is used.
+                    # Enum member without documentation. Must be documented
+                    # where the enum is used.
                     pass
             elif state == State.InNestedEnum:
                 if line.startswith("///"):
@@ -492,5 +492,7 @@ class State:
 
 contents = substitute(contents, "FORMAT_STYLE_OPTIONS", options_text)
 
-with open(args.output if args.output else DOC_FILE, "wb") as output:
-    output.write(contents.encode())
+with open(
+    args.output if args.output else DOC_FILE, "w", newline="", encoding="utf-8"
+) as f:
+    f.write(contents)
diff --git a/clang/test/Format/docs_updated.test b/clang/test/Format/docs_updated.test
index 17066650a12677..98d330e37ef450 100644
--- a/clang/test/Format/docs_updated.test
+++ b/clang/test/Format/docs_updated.test
@@ -1,5 +1,6 @@
 // RUN: %python %S/../../docs/tools/dump_format_style.py -o %t.style
-// RUN: diff %t.style %S/../../docs/ClangFormatStyleOptions.rst
+// RUN: diff --strip-trailing-cr %t.style \
+// RUN:   %S/../../docs/ClangFormatStyleOptions.rst
 
 // RUN: %python %S/../../docs/tools/dump_format_help.py -o %t.help
-// RUN: diff %t.help %S/../../docs/ClangFormat.rst
+// RUN: diff --strip-trailing-cr %t.help %S/../../docs/ClangFormat.rst

``````````

</details>


https://github.com/llvm/llvm-project/pull/119666


More information about the cfe-commits mailing list