Skip to content

Commit 7958d60

Browse files
DavidSpickettaokblast
authored andcommitted
[llvm][docs] Correct description of %t lit substitution (llvm#164397)
%t is currently documented as: temporary file name unique to the test https://llvm.org/docs/CommandGuide/lit.html#substitutions Which I take to mean if the path is a/b/c/tempfile, then %t would be tempfile. It is not, it's the whole path. (which is hinted at by %basename_t, but why would you read that if you didn't need to use it) As seen in llvm#164396 this can create confusion when people use it as if it were just the file name. Make it clear in the docs that this is a unique path, which can be used to make files or folders.
1 parent b64ad5f commit 7958d60

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

llvm/docs/CommandGuide/lit.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ TestRunner.py:
628628
%{fs-src-root} root component of file system paths pointing to the LLVM checkout
629629
%{fs-tmp-root} root component of file system paths pointing to the test's temporary directory
630630
%{fs-sep} file system path separator
631-
%t temporary file name unique to the test
631+
%t a path unique to the test (which may be used to make files or directories)
632632
%basename_t The last path component of %t but without the ``.tmp`` extension (deprecated, use ``%{t:stem}`` instead)
633633
%% %
634634
%/s %s but ``\`` is replaced by ``/``

0 commit comments

Comments
 (0)