This revision was automatically updated to reflect the committed changes.
Closed by commit rL271989: [include-fixer] Mention more details in the
document. (authored by hokein).
Changed prior to commit:
http://reviews.llvm.org/D20467?vs=59838&id=59839#toc
Repository:
rL LLVM
http://reviews.llvm.org/D20467
Files:
clang-tools-extra/trunk/docs/ReleaseNotes.rst
clang-tools-extra/trunk/docs/include-fixer.rst
Index: clang-tools-extra/trunk/docs/include-fixer.rst
===================================================================
--- clang-tools-extra/trunk/docs/include-fixer.rst
+++ clang-tools-extra/trunk/docs/include-fixer.rst
@@ -41,14 +41,16 @@
.. code-block:: console
$ cd path/to/llvm-build
+ $ ninja find-all-symbols // build find-all-symbols tool.
+ $ ninja clang-include-fixer // build clang-include-fixer tool.
$ ls compile_commands.json # Make sure compile_commands.json exists.
compile_commands.json
$
path/to/llvm/source/tools/clang/tools/extra/include-fixer/find-all-symbols/tool/run-find-all-symbols.py
... wait as clang indexes the code base ...
$ ln -s $PWD/find_all_symbols_db.yaml path/to/llvm/source/ # Link database
into the source tree.
$ ln -s $PWD/compile_commands.json path/to/llvm/source/ # Also link
compilation database if it's not there already.
$ cd path/to/llvm/source
- $ clang-include-fixer -db=yaml path/to/file/with/missing/include.cpp
+ $ /path/to/clang-include-fixer -db=yaml path/to/file/with/missing/include.cpp
Added #include "foo.h"
Integrate with Vim
@@ -63,6 +65,14 @@
This enables `clang-include-fixer` for NORMAL and VISUAL mode. Change ``,cf``
to
another binding if you need clang-include-fixer on a different key.
+Make sure vim can find :program:`clang-include-fixer`:
+
+- Add the path to :program:`clang-include-fixer` to the PATH environment
variable.
+- Or set ``g:clang_include_fixer_path`` in vimrc: ``let
g:clang_include_fixer_path=path/to/clang-include-fixer``
+
+You can customize the number of headers being shown by setting
+``let g:clang_include_fixer_maximum_suggested_headers=5``
+
See ``clang-include-fixer.py`` for more details.
How it Works
Index: clang-tools-extra/trunk/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/trunk/docs/ReleaseNotes.rst
+++ clang-tools-extra/trunk/docs/ReleaseNotes.rst
@@ -44,7 +44,8 @@
Major New Features
------------------
-- Feature1...
+- :program:`clang-include-fixer`, a tool that provides an automated way of
+ adding ``#include`` directives for missing symbols in one translation unit.
Improvements to clang-query
---------------------------
Index: clang-tools-extra/trunk/docs/include-fixer.rst
===================================================================
--- clang-tools-extra/trunk/docs/include-fixer.rst
+++ clang-tools-extra/trunk/docs/include-fixer.rst
@@ -41,14 +41,16 @@
.. code-block:: console
$ cd path/to/llvm-build
+ $ ninja find-all-symbols // build find-all-symbols tool.
+ $ ninja clang-include-fixer // build clang-include-fixer tool.
$ ls compile_commands.json # Make sure compile_commands.json exists.
compile_commands.json
$ path/to/llvm/source/tools/clang/tools/extra/include-fixer/find-all-symbols/tool/run-find-all-symbols.py
... wait as clang indexes the code base ...
$ ln -s $PWD/find_all_symbols_db.yaml path/to/llvm/source/ # Link database into the source tree.
$ ln -s $PWD/compile_commands.json path/to/llvm/source/ # Also link compilation database if it's not there already.
$ cd path/to/llvm/source
- $ clang-include-fixer -db=yaml path/to/file/with/missing/include.cpp
+ $ /path/to/clang-include-fixer -db=yaml path/to/file/with/missing/include.cpp
Added #include "foo.h"
Integrate with Vim
@@ -63,6 +65,14 @@
This enables `clang-include-fixer` for NORMAL and VISUAL mode. Change ``,cf`` to
another binding if you need clang-include-fixer on a different key.
+Make sure vim can find :program:`clang-include-fixer`:
+
+- Add the path to :program:`clang-include-fixer` to the PATH environment variable.
+- Or set ``g:clang_include_fixer_path`` in vimrc: ``let g:clang_include_fixer_path=path/to/clang-include-fixer``
+
+You can customize the number of headers being shown by setting
+``let g:clang_include_fixer_maximum_suggested_headers=5``
+
See ``clang-include-fixer.py`` for more details.
How it Works
Index: clang-tools-extra/trunk/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/trunk/docs/ReleaseNotes.rst
+++ clang-tools-extra/trunk/docs/ReleaseNotes.rst
@@ -44,7 +44,8 @@
Major New Features
------------------
-- Feature1...
+- :program:`clang-include-fixer`, a tool that provides an automated way of
+ adding ``#include`` directives for missing symbols in one translation unit.
Improvements to clang-query
---------------------------
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
