[PATCH] D114011: Add a clang-transformer tutorial

[Dmitri Gribenko via Phabricator via cfe-commits]

gribozavr2 accepted this revision.
gribozavr2 added inline comments.
This revision is now accepted and ready to land.


================
Comment at: clang/docs/ClangTransformerTutorial.rst:52
+Patterns in Transformer are expressed with
+`clang's AST matchers <https://clang.llvm.org/docs/LibASTMatchers.html>`_.
+Matchers are a language of combinators for describing portions of a clang
----------------
Please use relative links:

```
:doc:`LibASTMatchers`
```


================
Comment at: clang/docs/ClangTransformerTutorial.rst:64
+encouraged to start with the recommended references in
+[Related Reading](#related-reading).
+
----------------
Does this link work? Or does it need to use the RST syntax?


================
Comment at: clang/docs/ClangTransformerTutorial.rst:69
+
+Assume you have an API which forbids functions from being named "MkX" and you
+want to write a check that catches any violations of this rule. We can express
----------------
"an api" -> "a style guide rule"?


================
Comment at: clang/docs/ClangTransformerTutorial.rst:94
+
+Example: function rename
+^^^^^^^^^^^^^^^^^^^^^^^^
----------------
"renaming a function"


================
Comment at: clang/docs/ClangTransformerTutorial.rst:320
+
+That is, an ``EditGenerator`` is function that maps a ``MatchResult`` and to a set
+of edits, or fails. This signature supports a very general form of computation
----------------
Remove "and"?


================
Comment at: clang/docs/ClangTransformerTutorial.rst:355
+
+Sometimes, a modification to the code might require the inclusion a particular
+header file. To this end, users can modify rules to specify include directives
----------------
"of a particular"


================
Comment at: clang/docs/ClangTransformerTutorial.rst:396
+*   `Matching the Clang AST <https://clang.llvm.org/docs/LibASTMatchers.html>`_
+*   `AST Matcher Reference <https://clang.llvm.org/docs/LibASTMatchersReference.html>`_
+
----------------
Please use relative links with `:doc:`.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D114011/new/

https://reviews.llvm.org/D114011