[clang-format] Add test to ensure formatting options docs are updated

[boomanaiden154]

This patch adds a lit test to clang format to ensure that the ClangFormatStyleOptions doc page has been updated appropriately. The test just runs the automatic update script and diffs the outputs to ensure they are the same.

[llvmbot]

@llvm/pr-subscribers-clang-format

@llvm/pr-subscribers-clang

Author: Aiden Grossman (boomanaiden154)

Changes

This patch adds a lit test to clang format to ensure that the ClangFormatStyleOptions doc page has been updated appropriately. The test just runs the automatic update script and diffs the outputs to ensure they are the same.

---

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

3 Files Affected:

• (modified) clang/docs/tools/dump_format_style.py (+2-1)
• (added) clang/test/Format/docs_updated.test (+2)
• (modified) clang/test/Format/lit.local.cfg (+1)

diff --git a/clang/docs/tools/dump_format_style.py b/clang/docs/tools/dump_format_style.py
index af0e658fcdc55d..c82b4479f299d9 100755
--- a/clang/docs/tools/dump_format_style.py
+++ b/clang/docs/tools/dump_format_style.py
@@ -487,5 +487,6 @@ class State:
 
 contents = substitute(contents, "FORMAT_STYLE_OPTIONS", options_text)
 
-with open(DOC_FILE, "wb") as output:
+output_file_path = sys.argv[1] if len(sys.argv) == 2 else DOC_FILE
+with open(output_file_path, "wb") as output:
     output.write(contents.encode())
diff --git a/clang/test/Format/docs_updated.test b/clang/test/Format/docs_updated.test
new file mode 100644
index 00000000000000..fe2e4f1bd13a1b
--- /dev/null
+++ b/clang/test/Format/docs_updated.test
@@ -0,0 +1,2 @@
+// RUN: %python %S/../../docs/tools/dump_format_style.py %t
+// RUN: diff %t %S/../../docs/ClangFormatStyleOptions.rst
diff --git a/clang/test/Format/lit.local.cfg b/clang/test/Format/lit.local.cfg
index 3eb0f54ceaa6f9..8acf02725d701b 100644
--- a/clang/test/Format/lit.local.cfg
+++ b/clang/test/Format/lit.local.cfg
@@ -17,4 +17,5 @@ config.suffixes = [
     ".textpb",
     ".asciipb",
     ".td",
+    ".test"
 ]

[mikaelholmen]

Hello,

When running the new testcase the file plurals.txt, which is in the repo, is opened for writing? Is this really desired?

I noticed this when I tried to run top of tree lit tests in an environment setup with read-only access on the files in the repo.

[mikaelholmen]

Hello,

When running the new testcase the file plurals.txt, which is in the repo, is opened for writing? Is this really desired?

I noticed this when I tried to run top of tree lit tests in an environment setup with read-only access on the files in the repo.

Hm, or it's not related to the testcase, but it happens every time we build now due to 6bec180

[clang-format] Add plurals.txt to DEPENDS of style_options_depends

? So when we build, plurals.txt is opened for writing?

[boomanaiden154]

Hm, or it's not related to the testcase, but it happens every time we build now due to 6bec180

That's more likely to be due to #111513. That got reverted. If it's still an issue here, let me know. Everything should be read only here, but that doesn't mean things aren't getting opened with inappropriate permissions.

[owenca]

When running the new testcase the file plurals.txt, which is in the repo, is opened for writing? Is this really desired?

Fixed in 74d29c6.

[mikaelholmen]

Thanks!