Randomize layout docs #27

Nixoncole · 2019-02-26T03:16:55Z

Here is a PR for the stand alone documentation for the radnomize_layout attribute.

…into no_ranomize_layout_attr

PR was slightly behind, update and fix punctuation

…ndstruct/llvm-project into no_ranomize_layout_attr

All attributes that emit warnings are required to be members of a warning group; this is checked by the clang-test regression suite.

All supported attributes must be etched in stone in the supported attributes regression test.

nforbus

I don't see any issues with this documentation.

tim-pugh · 2019-02-26T04:30:44Z

Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:18: error: Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.tdEnd of line in string literal:
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:make[2]: *** [tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrImpl.dir/build.make:93: tools/clang/include/clang/Sema/AttrParsedAttrImpl.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:23680: tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrImpl.dir/all] Error 2
make[1]: *** Waiting for unfinished jobs....
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td:Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td  let Heading = "randomize_layout;:
                ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.tdmake[2]: *** [tools/clang/include/clang/Sema/CMakeFiles/ClangAttrTemplateInstantiate.dir/build.make:93: tools/clang/include/clang/Sema/AttrTemplateInstantiate.inc] Error 1
:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.tdIncluded from :/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td:Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td:4102:17: error: make[1]: *** [CMakeFiles/Makefile2:23712: tools/clang/include/clang/Sema/CMakeFiles/ClangAttrTemplateInstantiate.dir/all] Error 2
Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td:Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../Basic/Attr.td:55:
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td:4102:18: /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td:4102:error: 18: End of line in string literal
error: End of line in string literal
  let Heading = "randomize_layout;
   let Heading = "randomize_layout; 
                            ^ 
   ^
Included from Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../Basic/Attr.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td::5555:
:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Sema/../..//clang/Basic/AttrDocs.td::41024102::17make[2]: *** [tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrList.dir/build.make:93: tools/clang/include/clang/Sema/AttrParsedAttrList.inc] Error 1
17: : error: error: Unknown token when parsing a value
Unknown token when parsing a value
  let Heading = "randomize_layout;
   let Heading = "randomize_layout; 
                          ^ 
   ^
make[2]: *** [tools/clang/include/clang/Sema/CMakeFiles/ClangAttrSpellingListIndex.dir/build.make:93: tools/clang/include/clang/Sema/AttrSpellingListIndex.inc] Error 1
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
            55 :
    ^
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102:18: Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td:error: 55:
End of line in string literal
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102  let Heading = "randomize_layout;:
17:  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td : error: 4102 : 18 Unknown token when parsing a value:  
    let Heading = "randomize_layout; error: 
    End of line in string literal  
        let Heading = "randomize_layout;^ 

          Included from   /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td  :   55  :
^ 
 /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td : 4102 : 17 :  ^
error: Unknown token when parsing a value
  let Heading = "randomize_layout;
   Included from  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td :     5555 :
:
  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td : 4102 :^17
: /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../..//clang/Basic/AttrDocs.td:4102:error: 18: Unknown token when parsing a value
error:   let Heading = "randomize_layout;
End of line in string literal
             let Heading = "randomize_layout; 
      ^ 
              ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
make[2]: *** [tools/clang/include/clang/Basic/CMakeFiles/ClangAttrList.dir/build.make:117: tools/clang/include/clang/Basic/AttrList.inc] Error 1
make[2]: *** [tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrKinds.dir/build.make:93: tools/clang/include/clang/Sema/AttrParsedAttrKinds.inc] Error 1
make[2]: *** [tools/clang/include/clang/AST/CMakeFiles/ClangAttrVisitor.dir/build.make:97: tools/clang/include/clang/AST/AttrVisitor.inc] Error 1
make[2]: *** [tools/clang/include/clang/AST/CMakeFiles/ClangAttrTraverse.dir/build.make:97: tools/clang/include/clang/AST/AttrNodeTraverse.inc] Error 1
make[2]: *** [tools/clang/include/clang/Parse/CMakeFiles/ClangAttrSubMatchRulesParserStringSwitches.dir/build.make:93: tools/clang/include/clang/Parse/AttrSubMatchRulesParserStringSwitches.inc] Error 1
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../Basic/Attr.td:make[2]: *** [tools/clang/include/clang/AST/CMakeFiles/ClangAttrClasses.dir/build.make:97: tools/clang/include/clang/AST/Attrs.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:22401: tools/clang/include/clang/AST/CMakeFiles/ClangAttrVisitor.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:22497: tools/clang/include/clang/AST/CMakeFiles/ClangAttrTraverse.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23045: tools/clang/include/clang/Basic/CMakeFiles/ClangAttrList.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23562: tools/clang/include/clang/Parse/CMakeFiles/ClangAttrSubMatchRulesParserStringSwitches.dir/all] Error 2
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.tdmake[1]: *** [CMakeFiles/Makefile2:22561: tools/clang/include/clang/AST/CMakeFiles/ClangAttrClasses.dir/all] Error 2
:make[1]: *** [CMakeFiles/Makefile2:23648: tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrList.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23744: tools/clang/include/clang/Sema/CMakeFiles/ClangAttrSpellingListIndex.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23776: tools/clang/include/clang/Sema/CMakeFiles/ClangAttrParsedAttrKinds.dir/all] Error 2
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../..//clang/Basic/AttrDocs.td:make[2]: *** [tools/clang/include/clang/Basic/CMakeFiles/ClangAttrSubjectMatchRuleList.dir/build.make:117: tools/clang/include/clang/Basic/AttrSubMatchRulesList.inc] Error 1
4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
             55make[2]: *** [tools/clang/include/clang/AST/CMakeFiles/ClangAttrImpl.dir/build.make:97: tools/clang/include/clang/AST/AttrImpl.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:23461: tools/clang/include/clang/Basic/CMakeFiles/ClangAttrSubjectMatchRuleList.dir/all] Error 2
Included from Included from  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../Basic/Attr.tdIncluded from :
 /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../Basic/Attr.td:::  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../..//clang/Basic/AttrDocs.td^:
4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
Included from  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../Basic/Attr.td :  55 :
  /home/timpugh_pdx_edu/llvm-project/clang/include/clang/AST/../..//clang/Basic/AttrDocs.td : 4102 : 17 :    error:  ^
Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../..//clang/Basic/AttrDocs.td:4102:18: error: End of line in string literal
  let Heading = "randomize_layout;
                 ^
Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../Basic/Attr.td:55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Parse/../..//clang/Basic/AttrDocs.td:4102:17: error: Unknown token when parsing a value
  let Heading = "randomize_layout;
                ^
55:
55:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../..//clang/Basic/AttrDocs.td::41024102::1818: : error: error: End of line in string literalEnd of line in string literal

  let Heading = "randomize_layout;  let Heading = "randomize_layout;

                                  ^^

Included from Included from /home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/Attr.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../Basic/Attr.td::5555:
:
/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Basic/../..//clang/Basic/AttrDocs.td/home/timpugh_pdx_edu/llvm-project/clang/include/clang/Serialization/../..//clang/Basic/AttrDocs.td::41024102::1717: : error: error: Unknown token when parsing a valueUnknown token when parsing a value

  let Heading = "randomize_layout;  let Heading = "randomize_layout;

                                ^^

make[2]: *** [tools/clang/include/clang/Serialization/CMakeFiles/ClangAttrPCHRead.dir/build.make:93: tools/clang/include/clang/Serialization/AttrPCHRead.inc] Error 1
make[2]: *** [tools/clang/include/clang/Parse/CMakeFiles/ClangAttrParserStringSwitches.dir/build.make:93: tools/clang/include/clang/Parse/AttrParserStringSwitches.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:22593: tools/clang/include/clang/AST/CMakeFiles/ClangAttrImpl.dir/all] Error 2
make[2]: *** [tools/clang/include/clang/AST/CMakeFiles/ClangAttrTextDump.dir/build.make:97: tools/clang/include/clang/AST/AttrTextNodeDump.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:23594: tools/clang/include/clang/Parse/CMakeFiles/ClangAttrParserStringSwitches.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23859: tools/clang/include/clang/Serialization/CMakeFiles/ClangAttrPCHRead.dir/all] Error 2
make[2]: *** [tools/clang/include/clang/Basic/CMakeFiles/ClangAttrHasAttributeImpl.dir/build.make:117: tools/clang/include/clang/Basic/AttrHasAttributeImpl.inc] Error 1
make[2]: *** [tools/clang/include/clang/Serialization/CMakeFiles/ClangAttrPCHWrite.dir/build.make:93: tools/clang/include/clang/Serialization/AttrPCHWrite.inc] Error 1
make[1]: *** [CMakeFiles/Makefile2:22433: tools/clang/include/clang/AST/CMakeFiles/ClangAttrTextDump.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:23827: tools/clang/include/clang/Serialization/CMakeFiles/ClangAttrPCHWrite.dir/all] Error 2
make[1]: *** [CMakeFiles/Makefile2:22949: tools/clang/include/clang/Basic/CMakeFiles/ClangAttrHasAttributeImpl.dir/all] Error 2

…attributes

jeffreytakahashi · 2019-02-26T04:54:37Z

For future usage, Cole gave a great list of links and how to use this:

https://clang.llvm.org/docs/InternalsManual.html#documentation
clang-tblgen -gen-attr-docs -I /path/to/clang/include /path/to/clang/include/clang/Basic/Attr.td -o /path/to/clang/docs/AttributeReference.rst
https://llvm.org/docs/TableGen/BackEnds.html#attrdocs
https://llvm.org/docs/TableGen/index.html

tim-pugh

Compiled and ran clang-tblgen -gen-attr-docs -I /path/to/clang/include /path/to/clang/include/clang/Basic/Attr.td -o /path/to/clang/docs/AttributeReference.rst
and viewed the output.

Looks good!

tim-pugh · 2019-02-26T04:56:52Z

Navigate to ~/llvm-project/build/bin and run:

./clang-tblgen -gen-attr-docs -I ../../clang/include/ ../../clang/include/clang/Basic/Attr.td -o ../../clang/docs/AttributeReference.rst

and then navigate to

../../clang/docs/AttributeReference.rst

and search for "randomize_layout" to see the addition.

nforbus

Built and ran tbl-gen, everything ran fine.

Nixoncole and others added 18 commits February 11, 2019 19:39

Added the 'no_randomize_layout' attr to clang

5d6b7c1

Merge branch 'develop' of https://github.com/connorkuehl/llvm-project …

53fec8d

…into no_ranomize_layout_attr

WIP, first attempt at emitting compiler warning

456bd5a

Added declaration of Diagnostic(), receiving errors.

b1f11a3

builds, but cannot compile. Cant find stdio.h

dee16c7

Added the 'no_randomize_layout' attr to clang

063f1b1

WIP, first attempt at emitting compiler warning

938b5cf

Added declaration of Diagnostic(), receiving errors.

e1af06f

builds, but cannot compile. Cant find stdio.h

a4a855d

Clean up PR

9d3845e

PR was slightly behind, update and fix punctuation

Merge branch 'no_ranomize_layout_attr' of https://github.com/clang-ra…

287458e

…ndstruct/llvm-project into no_ranomize_layout_attr

Add DiagGroup to NoRandomizeLayout attribute

f94de06

All attributes that emit warnings are required to be members of a warning group; this is checked by the clang-test regression suite.

Add NoRandomizeLayout to supported attributes list

fadd247

All supported attributes must be etched in stone in the supported attributes regression test.

Add space after semicolon in warning message

ae1bf92

First draft for attribute documentation

7272914

Edit ClangRandstruct entry in AttrDocs.td

09a54e9

Docs for the single attribute, 'randomize_layout'.

9949798

touched up other docs ad ran 'clang-format'

f06d4cc

Nixoncole requested review from connorkuehl, Jafosterja, jcantrell, jeffreytakahashi, nforbus and tim-pugh February 26, 2019 03:17

nforbus previously approved these changes Feb 26, 2019

View reviewed changes

Removed 'header' that is only for when you include docs for multiple …

ca2372f

…attributes

Nixoncole dismissed nforbus’s stale review via ca2372f February 26, 2019 04:36

tim-pugh approved these changes Feb 26, 2019

View reviewed changes

Nixoncole requested a review from nforbus February 26, 2019 05:33

nforbus approved these changes Feb 26, 2019

View reviewed changes

jeffreytakahashi merged commit a9655bd into develop Feb 26, 2019

tim-pugh mentioned this pull request Feb 26, 2019

Revert "Randomize layout docs" #30

Closed

connorkuehl deleted the randomize_layout_docs branch July 6, 2019 15:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Randomize layout docs #27

Randomize layout docs #27

Nixoncole commented Feb 26, 2019

nforbus left a comment

tim-pugh commented Feb 26, 2019 •

edited

Loading

jeffreytakahashi commented Feb 26, 2019

tim-pugh left a comment

tim-pugh commented Feb 26, 2019 •

edited

Loading

nforbus left a comment

Randomize layout docs #27

Randomize layout docs #27

Conversation

Nixoncole commented Feb 26, 2019

nforbus left a comment

Choose a reason for hiding this comment

tim-pugh commented Feb 26, 2019 • edited Loading

jeffreytakahashi commented Feb 26, 2019

tim-pugh left a comment

Choose a reason for hiding this comment

tim-pugh commented Feb 26, 2019 • edited Loading

nforbus left a comment

Choose a reason for hiding this comment

tim-pugh commented Feb 26, 2019 •

edited

Loading

tim-pugh commented Feb 26, 2019 •

edited

Loading