This is an archive of the discontinued LLVM Phabricator instance.

Differential D139869

[lit] Document the 'target=<triple>' feature
ClosedPublic

Authored by probinson on Dec 12 2022, 11:54 AM.

Details

Reviewers
ldionne
Commits
rG566e34829fb6: [lit] Document the 'target=<triple>' feature
Summary

Apparently I forgot to do this when making the lit change in
https://github.com/llvm/llvm-project/commit/56470b72f1fc1727d5ee87e2fed96e7dad286230

Diff Detail

Unit TestsFailed

TimeTest
60,050 msx64 debian > libFuzzer.libFuzzer::fuzzer-leak.test
60,040 msx64 debian > libFuzzer.libFuzzer::minimize_crash.test

Event Timeline

probinson created this revision.Dec 12 2022, 11:54 AM
Herald added a project: Restricted Project. · View Herald TranscriptDec 12 2022, 11:54 AM
probinson requested review of this revision.Dec 12 2022, 11:54 AM
Herald added a project: Restricted Project. · View Herald TranscriptDec 12 2022, 11:54 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B202647: Diff 482215.Dec 12 2022, 12:56 PM
nigelp-xmos added a subscriber: nigelp-xmos.Dec 12 2022, 10:45 PM
probinson updated this revision to Diff 483362.Dec 15 2022, 3:17 PM

Also update examples.

Harbormaster completed remote builds in B203490: Diff 483362.Dec 15 2022, 7:44 PM
probinson added a comment.Dec 16 2022, 10:07 AM

I've just discovered there's a compiler-rt version of this file that also talks about triple substrings. I'll get to that in a bit.

ldionne accepted this revision.Dec 20 2022, 4:13 PM
This revision is now accepted and ready to land.Dec 20 2022, 4:13 PM
This revision was landed with ongoing or failed builds.Dec 21 2022, 6:11 AM
Closed by commit rG566e34829fb6: [lit] Document the 'target=<triple>' feature (authored by probinson). · Explain Why
This revision was automatically updated to reflect the committed changes.
probinson added a commit: rG566e34829fb6: [lit] Document the 'target=<triple>' feature.
Herald added a project: Restricted Project. · View Herald TranscriptDec 21 2022, 6:11 AM
Herald added subscribers: Restricted Project, Enna1. · View Herald Transcript

Revision Contents

PathSize
llvm/
docs/
23 lines

Diff 483362

llvm/docs/TestingGuide.rst

Show First 20 Lines • Show All 493 Lines • ▼ Show 20 Lines
that the test detect. Use ``XFAIL`` to mark a test as an expected failure. that the test detect. Use ``XFAIL`` to mark a test as an expected failure.
An ``XFAIL`` test will be successful if its execution fails, and An ``XFAIL`` test will be successful if its execution fails, and
will be a failure if its execution succeeds. will be a failure if its execution succeeds.
.. code-block:: llvm .. code-block:: llvm
; This test will be only enabled in the build with asserts. ; This test will be only enabled in the build with asserts.
; REQUIRES: asserts ; REQUIRES: asserts
; This test is disabled on Linux. ; This test is disabled when running on Linux.
; UNSUPPORTED: -linux- ; UNSUPPORTED: system-linux
; This test is expected to fail on PowerPC. ; This test is expected to fail when targeting PowerPC.
; XFAIL: powerpc ; XFAIL: target=powerpc{{.*}}
``REQUIRES`` and ``UNSUPPORTED`` and ``XFAIL`` all accept a comma-separated ``REQUIRES`` and ``UNSUPPORTED`` and ``XFAIL`` all accept a comma-separated
list of boolean expressions. The values in each expression may be: list of boolean expressions. The values in each expression may be:
- Features added to ``config.available_features`` by configuration files such as ``lit.cfg``. - Features added to ``config.available_features`` by configuration files such as ``lit.cfg``.
String comparison of features is case-sensitive. Furthermore, a boolean expression can String comparison of features is case-sensitive. Furthermore, a boolean expression can
contain any Python regular expression enclosed in ``{{ }}``, in which case the boolean contain any Python regular expression enclosed in ``{{ }}``, in which case the boolean
expression is satisfied if any feature matches the regular expression. Regular expression is satisfied if any feature matches the regular expression. Regular
expressions can appear inside an identifier, so for example ``he{{l+}}o`` would match expressions can appear inside an identifier, so for example ``he{{l+}}o`` would match
``helo``, ``hello``, ``helllo``, and so on. ``helo``, ``hello``, ``helllo``, and so on.
- Substrings of the target triple (``UNSUPPORTED`` and ``XFAIL`` only). - The default target triple, preceded by the string ``target=`` (for example,
``target=x86_64-pc-windows-msvc``). Typically regular expressions are used
to match parts of the triple (for example, ``target={{.*}}-windows{{.*}}``
to match any Windows target triple).
| ``REQUIRES`` enables the test if all expressions are true. | ``REQUIRES`` enables the test if all expressions are true.
| ``UNSUPPORTED`` disables the test if any expression is true. | ``UNSUPPORTED`` disables the test if any expression is true.
| ``XFAIL`` expects the test to fail if any expression is true. | ``XFAIL`` expects the test to fail if any expression is true.
As a special case, ``XFAIL: *`` is expected to fail everywhere. As a special case, ``XFAIL: *`` is expected to fail everywhere.
.. code-block:: llvm .. code-block:: llvm
; This test is disabled on Windows, ; This test is disabled when running on Windows,
; and is disabled on Linux, except for Android Linux. ; and is disabled when targeting Linux, except for Android Linux.
; UNSUPPORTED: windows, linux && !android ; UNSUPPORTED: system-windows, target={{.*linux.*}} && !target={{.*android.*}}
; This test is expected to fail on both PowerPC and ARM. ; This test is expected to fail when targeting PowerPC or running on Darwin.
; XFAIL: powerpc || arm ; XFAIL: target=powerpc{{.*}}, system-darwin
Substitutions Substitutions
------------- -------------
Besides replacing LLVM tool names the following substitutions are performed in Besides replacing LLVM tool names the following substitutions are performed in
RUN lines: RUN lines:
▲ Show 20 Lines • Show All 379 Lines • Show Last 20 Lines