Doc: Describe the experimental Silver Searcher plugin

Change-Id: I0a805a9f9a9f68175720eacd09ba7bdad9db92b0
Reviewed-by: default avatarPrzemyslaw Gorszkowski <pgorszkowski@gmail.com>
Reviewed-by: Orgad Shaneh's avatarOrgad Shaneh <orgads@gmail.com>
parent 58214f09
......@@ -1583,13 +1583,25 @@
\image qtcreator-search-filesystem.png
In the \uicontrol {Search engine} field, select
\uicontrol Internal to use the \QC search engine. Select
\uicontrol {Git Grep} to use Git to only search tracked
files in the Git work tree. To restrict the search to the
HEAD, a tag, a local or remote branch, or a commit hash,
enter a reference. Leave the field empty to search through
the file system.
In the \uicontrol {Search engine} field, select the search
engine to use:
\list
\li Select \uicontrol Internal to use the \QC search
engine.
\li Select \uicontrol {Git Grep} to use Git to only
search tracked files in the Git work tree. To
restrict the search to the HEAD, a tag, a local or
remote branch, or a commit hash, enter a reference.
Leave the field empty to search through the file
system.
\li Select \uicontrol {Silver Searcher} to use the
experimental Silver Searcher plugin. For more
information, see \l{Enabling Silver Searcher}.
\endlist
\li \uicontrol {Current File} searches only from the current
file.
......@@ -1634,6 +1646,32 @@
\note You can use \uicontrol {Advanced Find} also to search for symbols. For
more information, see \l{Finding Symbols}.
\section1 Enabling Silver Searcher
You can use Silver Searcher as a search engine in \QC if you install
Silver Searcher on the development PC and enable the experimental plugin.
To use Silver Searcher:
\list 1
\li Download and install Silver Searcher from
\l {https://geoff.greer.fm/ag/}{The Silver Searcher} or
\l {https://github.com/ggreer/the_silver_searcher}{GitHub}.
You might have to build Silver Searcher from sources for some
platforms.
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Utilities} > \uicontrol {SilverSearcher} to enable the
plugin.
\li Restart \QC to be able to use the plugin.
\li When searching, select \uicontrol {Silver Searcher} in the
\uicontrol {Search engine} field.
\endlist
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment