[llvm] add tool to verify mustache library #111487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Closed

PeterChou1 wants to merge 79 commits into llvm:main from PeterChou1:llvm-add-mustache-verify-tool

Contributor

PeterChou1 commented Oct 8, 2024

Depends on #105893

Adds a tool to verify the moustache spec

PeterChou1 added 30 commits

July 30, 2024 23:58


          [clang-doc] add suport for clang-doc enum generation

ac1c7b5


          [clang-doc] remove useless code

bcc4b0d


          [clang-doc] modify unittest

5fe47ca


          [clang-doc] address pr comments

28fb40f


          [clang-doc] revert CommentInfo change

0d150ea


          [clang-doc] fix test

e5e70b8


          [clang-doc] fix unittest

1c4f631


          [clang-doc] address pr comments

b8f3f9c


          [clang-doc] clang-format

bb98aad


          [llvm] implement support for mustache template language

c60e2b5


          Merge branch 'main' into llvm-add-mustache

0a20de8


          [llvm][Support] Finish implementation of Mustache

8290c38


          Merge branch 'llvm-add-mustache' of https://github.com/PeterChou1/llv…

07d31b4

…m-project into llvm-add-mustache


          [llvm][support] fix mustache test

6e893c0


          [llvm][support] add comments

976593e


          [llvm][support] add comments

6a60eab


          [llvm][support] use enumerate for loop

6a1fcc8


          Merge branch 'main' into llvm-add-mustache

f1c27af


          [llvm][support] clang-format

eb1e1a6


          Merge branch 'llvm-add-mustache' of https://github.com/PeterChou1/llv…

8ff1100

…m-project into llvm-add-mustache


          [llvm][support] fix mustache test

f4b0520


          [llvm][support] clang-format

7ffaeec


          [llvm][support] use llvm enumerate

746fb97


          Merge branch 'main' into llvm-add-mustache


          [llvm][support] fix unittest

bcc86fe


          Merge branch 'llvm-add-mustache' of https://github.com/PeterChou1/llv…

2ceb0b0

…m-project into llvm-add-mustache


          [llvm][support] clang-format

95ad7a6


          [llvm][support] address mustache comments

bb3b1ac


          [llvm][support] clang-format

d8aa85c


          [llvm][support] clang-format

0534a05

PeterChou1 added 5 commits

April 3, 2025 12:40


          fix index

6bf2231


          change cmake

a439e55


          fix doc

6a73432


          fix doc

ee21301


          fix doc

github-actions bot commented Apr 3, 2025 •

edited

Loading

✅ With the latest revision this PR passed the Python code formatter.

PeterChou1 added 2 commits

April 3, 2025 14:13


          fix doc

f6aa0c5


          add description

f7a68bd

Contributor Author

PeterChou1 commented Apr 3, 2025

Please call this llvm-mustache-spec -- let's try to avoid polluting the global namespace with niche tools.

I also wonder whether this shouldn't be a util rather than tool -- this is purely for internal use, right?

Yes this a utility purely for internal use, I did not realize there was already a utils folder

PeterChou1 requested review from nikic and ilovepi

April 3, 2025 20:04

Contributor

ilovepi commented Apr 3, 2025

ah, right. I forgot we build things under utils that's a much better place for this.

Overall the patch is much better. Once it's moved to utils I think it will be good. @nikic I seem to recall that we now prefer markdown over .rst files. Is that correct? I tried to find documentation for the policy, but I seem to be missing it in my grep/googling.

Contributor

nikic commented Apr 4, 2025

Overall the patch is much better. Once it's moved to utils I think it will be good. @nikic I seem to recall that we now prefer markdown over .rst files. Is that correct? I tried to find documentation for the policy, but I seem to be missing it in my grep/googling.

I believe doc files that are used for man page generation are required to use .rst, because we don't want ability to generate man pages with just a sphinx dependency.

nikic reviewed

View reviewed changes

llvm/docs/CommandGuide/llvm-mustachespec.rst

		@@ -0,0 +1,12 @@
		llvm-mustachespec - LLVM tool to test Mustache Compliance Library

Contributor

nikic Apr 4, 2025

Suggested change

      
            llvm-mustachespec - LLVM tool to test Mustache Compliance Library
          
            llvm-mustachespec - LLVM tool to test Mustache Library Compliance

Possibly?

llvm/docs/CommandGuide/llvm-mustachespec.rst

+              llvm-mustachespec - LLVM tool to test Mustache Compliance Library
+              =================================================================
+              llvm-mustachespec test the mustache spec conformance of the LLVM

Contributor

nikic Apr 4, 2025

Suggested change

      
            llvm-mustachespec test the mustache spec conformance of the LLVM
          
            llvm-mustachespec tests the mustache spec conformance of the LLVM

llvm/docs/CommandGuide/llvm-mustachespec.rst

+              =================================================================
+              llvm-mustachespec test the mustache spec conformance of the LLVM
+              mustache library. The spec can be found here https://github.com/mustache/spec

Contributor

nikic Apr 4, 2025

Suggested change

      
            mustache library. The spec can be found here https://github.com/mustache/spec
          
            mustache library. The spec can be found here: `Mustache Spec <https://github.com/mustache/spec>`_.

or something.

llvm/docs/CommandGuide/llvm-mustachespec.rst


		.. program:: llvm-mustachespec

		Outputs the number of tests failures and success in the spec

Contributor

nikic Apr 4, 2025

Suggested change

      
            Outputs the number of tests failures and success in the spec
          
            Outputs the number of tests failures and successes in the spec.

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

		@@ -0,0 +1,104 @@
		//===- llvm-mustachespec.cpp - The LLVM Modular Optimizer

Contributor

nikic Apr 4, 2025

Suggested change

//===- llvm-mustachespec.cpp - The LLVM Modular Optimizer

We no longer include this line.

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

+              //    Triple Mustache - Standalone
+              //    Triple Mustache With Padding
+              //    Standalone Indentation
+              //    Implicit Iterator - Triple mustache

Contributor

nikic Apr 4, 2025

I wonder whether it would make sense to include this list directly in the program, and report these as "xfail"? That way it's easy to see whether there are any unexpected failures without manually comparing to this list.

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

+                                               cl::OneOrMore);
+              void runThroughTest(StringRef InputFile) {
+                llvm::outs() << "Running Tests: " << InputFile << "\n";

Contributor

nikic Apr 4, 2025

Suggested change

      
              llvm::outs() << "Running Tests: " << InputFile << "\n";
          
              outs() << "Running Tests: " << InputFile << "\n";

You're using using namespace llvm, don't need all these llvm:: prefixes.

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

Comment on lines +51 to +53

+                if (auto EC = BufferOrError.getError()) {
+                  return;
+                }

Contributor

nikic Apr 4, 2025

Shouldn't the error get reported?

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

+                  return;
+                }
+                // Get test
+                Array *Obj = (*Json).getAsObject()->getArray("tests");

Contributor

nikic Apr 4, 2025

Suggested change

      
              Array *Obj = (*Json).getAsObject()->getArray("tests");
          
              Array *Obj = Json->getAsObject()->getArray("tests");

This looks a bit odd, does this work?

llvm/utils/llvm-mustachespec/llvm-mustachespec.cpp

+                  if (Partials) {
+                    for (auto &PartialPairs : *Partials->getAsObject()) {
+                      const auto &[Partial, Str] = PartialPairs;
+                      T.registerPartial((*Str.getAsString()).str(), Partial.str());

Contributor

nikic Apr 4, 2025

Suggested change

      
                    T.registerPartial((*Str.getAsString()).str(), Partial.str());
          
                    T.registerPartial(Str.getAsString()->str(), Partial.str());

ilovepi mentioned this pull request

[clang-doc][NFC] refactor out file helpers #134298

Merged

ilovepi added a commit to ilovepi/llvm-project that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

9b9daca

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in llvm#111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

b6defce

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi mentioned this pull request

[llvm] Add a tool to check mustache compliance against the public spec #142813

Merged

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

b05caf5

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

5469d49

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

eec5619

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

22e099f

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

dab7e62

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec

7c18f69

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

ilovepi added a commit that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec (

ad2a2b8

#142813)

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in #111487.

Co-authored-by: Peter Chou <[email protected]>

Contributor

ilovepi commented Jun 11, 2025

This was completed in #142813

ilovepi closed this

tomtor pushed a commit to tomtor/llvm-project that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec (

c124682

llvm#142813)

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in llvm#111487.

Co-authored-by: Peter Chou <[email protected]>

arjunUpatel mentioned this pull request

[lldb] Revive TestSimulatorPlatform.py (#142244) arjunUpatel/llvm-project#1

Closed

akuhlens pushed a commit to akuhlens/llvm-project that referenced this pull request


          [llvm] Add a tool to check mustache compliance against the public spec (

484fdee

llvm#142813)

This is a cli tool to that tests the conformance of LLVM's mustache
implementation against the public Mustache spec, hosted at
https://github.com/mustache/spec. This is a revised version of the
patches in llvm#111487.

Co-authored-by: Peter Chou <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet