[clang-format] Explicitly open DOC_FILE with utf-8 in dump_format_style.py #79805
+1
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…le.py. The dump_format_style script generates the clang-format style options documentation. There was an issue where the script could include spurious characters in the output when run in windows. It appears that it wasn't defaulting to the correct encoding when reading the input. This has been addressed by explicitly setting the encoding when opening the file.
|
@llvm/pr-subscribers-clang-format @llvm/pr-subscribers-clang Author: None (rmarker) ChangesThe dump_format_style.py script generates the clang-format style options documentation. Full diff: https://github.com/llvm/llvm-project/pull/79805.diff 1 Files Affected:
diff --git a/clang/docs/tools/dump_format_style.py b/clang/docs/tools/dump_format_style.py
index 75d4a044ef19f68..e41891f07de2e32 100755
--- a/clang/docs/tools/dump_format_style.py
+++ b/clang/docs/tools/dump_format_style.py
@@ -474,7 +474,7 @@ class State:
opts = sorted(opts, key=lambda x: x.name)
options_text = "\n\n".join(map(str, opts))
-with open(DOC_FILE) as f:
+with open(DOC_FILE, encoding="utf-8") as f:
contents = f.read()
contents = substitute(contents, "FORMAT_STYLE_OPTIONS", options_text)
|
|
@HazardyKnusperkeks, @owenca, extracted this change from #78011. |
owenca
added
clang-format
and removed
clang
owenca
approved these changes
Jan 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The dump_format_style.py script generates the clang-format style options documentation.
There was an issue where the script could include spurious characters in the output when run in windows. It appears that it wasn't defaulting to the correct encoding when reading the input.
This has been addressed by explicitly setting the encoding when opening the file.