summaryrefslogtreecommitdiffstats
path: root/llvm/docs/TableGen
diff options
context:
space:
mode:
authorSean Silva <silvas@purdue.edu>2014-02-09 02:43:50 +0000
committerSean Silva <silvas@purdue.edu>2014-02-09 02:43:50 +0000
commitcc373354b863ca594875bf7355230fab2bab0f96 (patch)
tree280204423a15a36224381058eea6a87d1ea86ae4 /llvm/docs/TableGen
parent97497b0f1cd3384dfdd1ecc1df519ca74e9d1f9b (diff)
downloadbcm5719-llvm-cc373354b863ca594875bf7355230fab2bab0f96.tar.gz
bcm5719-llvm-cc373354b863ca594875bf7355230fab2bab0f96.zip
[docs] TableGen easter egg: Multiline string literals
They're called code fragments, but they are really multiline string literals. Just spotted this usage in a patch by Aaron using "code fragments" for holding documentation text. I remember someone bemoaning the lack of multiline string literals in TableGen, so I'm explicitly documenting that code fragments are multiline string literals. Let it be known that any use case needing multiline string literals in TableGen (such as descriptions of options, or whatnot) can use use code fragments (instead of C-style string concatenation or exceedingly long lines). E.g. class Bar<int n>; class Baz<int n>; class Doc<string desc> { string Desc = desc; } def Foo : Bar<1>, Baz<3>, Doc<[{ This Foo is a Bar, and also a Baz. It can take 3 values: * Qux * Quux * Quuux }]>; llvm-svn: 201033
Diffstat (limited to 'llvm/docs/TableGen')
-rw-r--r--llvm/docs/TableGen/LangRef.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/llvm/docs/TableGen/LangRef.rst b/llvm/docs/TableGen/LangRef.rst
index bd28a9031d7..e3db3aa6271 100644
--- a/llvm/docs/TableGen/LangRef.rst
+++ b/llvm/docs/TableGen/LangRef.rst
@@ -74,6 +74,9 @@ TableGen also has two string-like literals:
TokString: '"' <non-'"' characters and C-like escapes> '"'
TokCodeFragment: "[{" <shortest text not containing "}]"> "}]"
+:token:`TokCodeFragment` is essentially a multiline string literal
+delimited by ``[{`` and ``}]``.
+
.. note::
The current implementation accepts the following C-like escapes::
OpenPOWER on IntegriCloud