Skip to content

Commit

Permalink
Update some clang plugin documentation.
Browse files Browse the repository at this point in the history
Review URL: https://codereview.chromium.org/1502453002

Cr-Commit-Position: refs/heads/master@{#363105}
  • Loading branch information
jyasskin authored and Commit bot committed Dec 4, 2015
1 parent 10ba446 commit 37110bc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
12 changes: 9 additions & 3 deletions docs/clang.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,17 @@ is used by default when clang is used.

If you're working on the plugin, you can build it locally like so:

1. Run `./tools/clang/scripts/update.sh --force-local-build --without-android`
1. Run `./tools/clang/scripts/update.py --force-local-build --without-android`
to build the plugin.
1. Build with clang like described above.
1. Run `ninja -C third_party/llvm-build/Release+Asserts/` to build incrementally.
1. Build with clang like described above, but, if you use goma, disable it.

To test the FindBadConstructs plugin, run:

(cd tools/clang/plugins/tests && \
./test.sh ../../../../third_party/llvm-build/Release+Asserts/bin/clang \
../../../../third_party/llvm-build/Release+Asserts/lib/libFindBadConstructs.so)

TODO: writing_clang_plugins does not exist.
To run [other plugins](writing_clang_plugins.md), add these to your
`GYP_DEFINES`:

Expand Down
4 changes: 2 additions & 2 deletions tools/clang/plugins/README.chromium
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Documentation for this code is:

- http://code.google.com/p/chromium/wiki/Clang
- http://code.google.com/p/chromium/wiki/WritingClangPlugins
- https://chromium.googlesource.com/chromium/src/+/master/docs/clang.md
- https://chromium.googlesource.com/chromium/src/+/master/docs/writing_clang_plugins.md

0 comments on commit 37110bc

Please sign in to comment.