[docs] TableGen easter egg: Multiline string literals
authorSean Silva <silvas@purdue.edu>
Sun, 9 Feb 2014 02:43:50 +0000 (02:43 +0000)
committerSean Silva <silvas@purdue.edu>
Sun, 9 Feb 2014 02:43:50 +0000 (02:43 +0000)
commitf408f0f0d7854aabd839f1bea57aace940aadfe4
tree1caa35e6c6da5ed3339979307d7b7288c61ba7c7
parent8e616d32bd6a2ef4fb3326b4d4664b426369def9
[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
    }]>;

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@201033 91177308-0d34-0410-b5e6-96231b3b80d8
docs/TableGen/LangRef.rst