Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
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=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 --- ___
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
hokein updated this revision to Diff 59838. hokein added a comment. Fix typo. http://reviews.llvm.org/D20467 Files: docs/ReleaseNotes.rst docs/include-fixer.rst Index: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ 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: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ 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
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
bkramer accepted this revision. bkramer added a comment. This revision is now accepted and ready to land. Two more nits, looks good otherwise :) Comment at: docs/include-fixer.rst:73 @@ +72,3 @@ + +You can custonmize the number of headers being showed by setting +``let g:clang_include_fixer_maximum_suggested_headers=5`` typo custo**n**mize, headers being **shown** http://reviews.llvm.org/D20467 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
hokein updated this revision to Diff 59725. hokein marked 3 inline comments as done. hokein added a comment. Add comments. http://reviews.llvm.org/D20467 Files: docs/ReleaseNotes.rst docs/include-fixer.rst Index: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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 custonmize the number of headers being showed by setting +``let g:clang_include_fixer_maximum_suggested_headers=5`` + See ``clang-include-fixer.py`` for more details. How it Works Index: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ 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: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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 custonmize the number of headers being showed by setting +``let g:clang_include_fixer_maximum_suggested_headers=5`` + See ``clang-include-fixer.py`` for more details. How it Works Index: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ 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
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
bkramer added inline comments. Comment at: docs/ReleaseNotes.rst:47 @@ -46,2 +46,3 @@ -- Feature1... +- :program:`clang-include-fixer`, a tool provides an automated way of adding + ``#include`` directives for missing symbols in one translation unit. a tool **that** provides Comment at: docs/include-fixer.rst:70 @@ +69,3 @@ + +- Add :program:`clang-include-fixer` path in the environment PATH variable. +- Or set ``g:clang_include_fixer_path`` in vim configuration path: ``let g:clang_include_fixer_path=path/to/clang-include-fixer`` add the path to clang-include-fixer to the PATH environment variable Comment at: docs/include-fixer.rst:71 @@ +70,3 @@ +- Add :program:`clang-include-fixer` path in the environment PATH variable. +- Or set ``g:clang_include_fixer_path`` in vim configuration path: ``let g:clang_include_fixer_path=path/to/clang-include-fixer`` + in vimrc http://reviews.llvm.org/D20467 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
hokein added a comment. In http://reviews.llvm.org/D20467#435685, @Eugene.Zelenko wrote: > Could you please mention include-fixer in docs/ReleaseNotes.rst? This is > definitely major new feature in upcoming release. Done. http://reviews.llvm.org/D20467 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
hokein updated this revision to Diff 59721. hokein marked an inline comment as done. hokein added a comment. Address review comments. http://reviews.llvm.org/D20467 Files: docs/ReleaseNotes.rst docs/include-fixer.rst Index: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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 :program:`clang-include-fixer` path in the environment PATH variable. +- Or set ``g:clang_include_fixer_path`` in vim configuration path: ``let g:clang_include_fixer_path=path/to/clang-include-fixer`` + +You can custonmize the number of headers being showed by setting +``let g:clang_include_fixer_maximum_suggested_headers=5`` + See ``clang-include-fixer.py`` for more details. How it Works Index: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -44,7 +44,8 @@ Major New Features -- -- Feature1... +- :program:`clang-include-fixer`, a tool provides an automated way of adding + ``#include`` directives for missing symbols in one translation unit. Improvements to clang-query --- Index: docs/include-fixer.rst === --- docs/include-fixer.rst +++ 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 :program:`clang-include-fixer` path in the environment PATH variable. +- Or set ``g:clang_include_fixer_path`` in vim configuration path: ``let g:clang_include_fixer_path=path/to/clang-include-fixer`` + +You can custonmize the number of headers being showed by setting +``let g:clang_include_fixer_maximum_suggested_headers=5`` + See ``clang-include-fixer.py`` for more details. How it Works Index: docs/ReleaseNotes.rst === --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -44,7 +44,8 @@ Major New Features -- -- Feature1... +- :program:`clang-include-fixer`, a tool 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
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
bkramer added a comment. Sorry, this patch somehow got buried in my mail. Comment at: docs/include-fixer.rst:69 @@ +68,3 @@ +Make sure the path of :program:`clang-include-fixer` is in the environment PATH +variable. + Maybe also describe the g:clang_include_fixer_path that you can put into .vimrc? http://reviews.llvm.org/D20467 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
Re: [PATCH] D20467: [include-fixer] Mention more details in the document.
Eugene.Zelenko added a subscriber: Eugene.Zelenko. Eugene.Zelenko added a comment. Could you please mention include-fixer in docs/ReleaseNotes.rst? This is definitely major new feature in upcoming release. http://reviews.llvm.org/D20467 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
