aboutsummaryrefslogtreecommitdiff
path: root/llvm/docs/CommandGuide/llvm-test-mustache-spec.rst
blob: 8cd5a349e7e49dd559d51d9cdcb68ee178458c2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
llvm-test-mustache-spec - LLVM tool to test Mustache library compliance
=======================================================================

.. program:: llvm-test-mustache-spec

SYNOPSIS
--------

:program:`llvm-test-mustache-spec` [*inputs...*]

Description
-----------

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

To test against the spec, simply download the spec and pass the test JSON files
to the driver. Each spec file should have a list of tests for compliance with
the spec. These are loaded as test cases, and rendered with our Mustache
implementation, which is then compared against the expected output from the
spec.

The current implementation only supports non-optional parts of the spec, so
we do not expect any of the dynamic-names, inheritance, or lambda tests to
pass. Additionally, Triple Mustache is not supported. Unsupported tests are
marked as XFail and are removed from the XFail list as they are fixed.

The tool prints the number of test failures and successes in each of the test
files to standard output.

EXAMPLE
-------

.. code-block:: console

   $ llvm-test-mustache-spec path/to/specs/\*.json