Skip to content

Commit

Permalink
Update help and helm-ls-git-status-command docstring.
Browse files Browse the repository at this point in the history
* helm-ls-git.el (helm-ls-git-help-message): Do it.
(helm-ls-git-status-command):                Do it.
  • Loading branch information
Thierry Volpiatto committed Jun 2, 2017
1 parent 91dae5a commit 1253c76
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion helm-ls-git.el
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ Valid values are symbol 'absolute or 'relative (default)."
(const :tag "Show relative path" relative)))

(defcustom helm-ls-git-status-command 'vc-dir
"Favorite git-status command for emacs."
"Favorite git-status command for emacs.
If you want to use magit use `magit-status-internal' and not
`magit-status' which is working only interactively."
:group 'helm-ls-git
:type 'symbol)

Expand Down Expand Up @@ -155,6 +158,19 @@ To see files in submodules add the option \"--recurse-submodules\"."
** Tips
*** Start helm-ls-git
You can start with `helm-ls-git-ls' but you can also use the generic
`helm-browse-project' which will use `helm-ls-git' if you are in a git
project (actually supported backends are git, hg and svn).
*** You may want to use magit as git status command
By default helm-ls-git is using emacs `vc-dir' as `helm-ls-git-status-command',
perhaps you want to use something better like `magit-status' ?
If it's the case use `magit-status-internal' as value for `helm-ls-git-status-command'
as `magit-status' is working only interactively (it will not work from helm-ls-git).
*** Git grep usage
**** With no prefix arg.
Expand Down

0 comments on commit 1253c76

Please sign in to comment.