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

owenca · 2024-12-12T07:20:27Z

Fixes #119517.

llvmbot · 2024-12-12T07:21:01Z

@llvm/pr-subscribers-clang-format

Author: Owen Pan (owenca)

Changes

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 --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

llvmbot · 2024-12-12T07:21:02Z

@llvm/pr-subscribers-clang

Author: Owen Pan (owenca)

Changes

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 --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

boomanaiden154

Is the cleanup just running black? Would be better committed separately in my opinion. Either way, LGTM for both the cleanup and the test change.

owenca · 2024-12-13T07:24:35Z

Is the cleanup just running black? Would be better committed separately in my opinion.

See ea44647.

Fixes llvm#119517.

#119666 adds the `-strip-trailing-cr` flag to diff which is not supported on AIX switch to use the python implementation of diff instead

…) (#120276) llvm/llvm-project#119666 adds the `-strip-trailing-cr` flag to diff which is not supported on AIX switch to use the python implementation of diff instead

llvmbot added clang Clang issues not falling into any other category clang-format labels Dec 12, 2024

owenca requested a review from boomanaiden154 December 12, 2024 07:23

boomanaiden154 approved these changes Dec 12, 2024

View reviewed changes

[clang-format] Add --strip-trailing-cr to diff in docs_updated.test

8ee6f99

Fixes llvm#119517.

owenca force-pushed the 119517 branch from 6105a4b to 8ee6f99 Compare December 13, 2024 07:28

owenca merged commit d7a8e09 into llvm:main Dec 13, 2024
8 checks passed

owenca deleted the 119517 branch December 13, 2024 08:03

madanial0 mentioned this pull request Dec 17, 2024

[AIX] fix unsupported diff flag on AIX (-strip-trailing-cr) #120276

Merged

madanial0 added a commit that referenced this pull request Dec 17, 2024

[AIX] fix unsupported diff flag on AIX (-strip-trailing-cr) (#120276)

2a0091f

#119666 adds the `-strip-trailing-cr` flag to diff which is not supported on AIX switch to use the python implementation of diff instead

owenca removed the clang Clang issues not falling into any other category label Jan 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

owenca commented Dec 12, 2024 •

edited

Loading

Uh oh!

llvmbot commented Dec 12, 2024

Uh oh!

llvmbot commented Dec 12, 2024

Uh oh!

boomanaiden154 left a comment

Uh oh!

owenca commented Dec 13, 2024

Uh oh!

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

owenca commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

llvmbot commented Dec 12, 2024

Uh oh!

llvmbot commented Dec 12, 2024

Uh oh!

boomanaiden154 left a comment

Choose a reason for hiding this comment

Uh oh!

owenca commented Dec 13, 2024

Uh oh!

Uh oh!

Uh oh!

owenca commented Dec 12, 2024 •

edited

Loading