diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/magit.org | 59 | ||||
| -rw-r--r-- | docs/magit.texi | 61 |
2 files changed, 83 insertions, 37 deletions
diff --git a/docs/magit.org b/docs/magit.org index 99487e1..f9752ea 100644 --- a/docs/magit.org +++ b/docs/magit.org @@ -2258,42 +2258,65 @@ hooks and how to customize them. *** Status File List Sections -Its possible to limit the diffs in the current buffer to a certain -directory using ~D = f <DIRECTORY> RET g~. If you do that, then that -that also affects these functions. The diff filter can be used to -limit to multiple files. In that case these functions only respect -the first of the files and only if it is a directory. +These functions honor the buffer's file filter, which can be set using +~D - -~. - Function: magit-insert-untracked-files :: - Maybe insert a list or tree of untracked files. + This function may insert a list of untracked files. Whether it + actually does so, depends on the option described next. - The option ~magit-status-show-untracked-files~ (which see), in - cooperation with the Git variable ~status.showUntrackedFiles~, - control whether and how that is done. +- User Option: magit-status-show-untracked-files :: - If the first element of ~magit-buffer-diff-files~ is a directory, then - limit the list to files below that. The value of that variable can - be set using ~D -- DIRECTORY RET g~. + This option controls whether the above function inserts a list of + untracked files in the status buffer. -While the above function is a member of ~magit-status-section-hook~, -the following functions by default are not. + To disable listing untracked files in a specific repository only, + add the following to ~.dir-locals.el~: + + #+begin_src emacs-lisp + ((magit-status-mode + (magit-status-show-untracked-files . \"no\"))) + #+end_src + + Alternatively (and mostly for historic reasons), it is possible to + use ~git config~ to disable listing files for a specific repository, + using: + + #+begin_src shell-script + git config set --local status.showUntrackedFiles no + #+end_src + + This does *not* override the (if any) local value of this Lisp variable. + It also is not possible to use the Git variable to enable listing files + (in case the global value of this variable is nil). + +- User Option: magit-status-file-list-limit :: + + This option controls many files are listed at most in each section + that lists files in the status buffer. For performance reasons, it + is recommended that you do not increase this limit. + +While the above function is a member of ~magit-status-section-hook~ by +default, the following functions have to be explicitly added by the +user. Because that negatively affects performance, it is recommended +that you don't do that. - Function: magit-insert-tracked-files :: - Insert a tree of tracked files. + Insert a list of tracked files. - Function: magit-insert-ignored-files :: - Insert a tree of ignored files. + Insert a list of ignored files. - Function: magit-insert-skip-worktree-files :: - Insert a tree of skip-worktree files. + Insert a list of skip-worktree files. - Function: magit-insert-assumed-unchanged-files :: - Insert a tree of files that are assumed to be unchanged. + Insert a list of files that are assumed to be unchanged. *** Status Log Sections diff --git a/docs/magit.texi b/docs/magit.texi index 7524910..c51b44e 100644 --- a/docs/magit.texi +++ b/docs/magit.texi @@ -2641,41 +2641,64 @@ push-remote yet. @anchor{Status File List Sections} @subsection Status File List Sections -Its possible to limit the diffs in the current buffer to a certain -directory using @code{D = f <DIRECTORY> RET g}. If you do that, then that -that also affects these functions. The diff filter can be used to -limit to multiple files. In that case these functions only respect -the first of the files and only if it is a directory. +These functions honor the buffer's file filter, which can be set using +@code{D - -}. @defun magit-insert-untracked-files -Maybe insert a list or tree of untracked files. +This function may insert a list of untracked files. Whether it +actually does so, depends on the option described next. +@end defun -The option @code{magit-status-show-untracked-files} (which see), in -cooperation with the Git variable @code{status.showUntrackedFiles}, -control whether and how that is done. +@defopt magit-status-show-untracked-files +This option controls whether the above function inserts a list of +untracked files in the status buffer. -If the first element of @code{magit-buffer-diff-files} is a directory, then -limit the list to files below that. The value of that variable can -be set using @code{D -- DIRECTORY RET g}. -@end defun +To disable listing untracked files in a specific repository only, +add the following to @code{.dir-locals.el}: + +@lisp +((magit-status-mode + (magit-status-show-untracked-files . \"no\"))) +@end lisp + +Alternatively (and mostly for historic reasons), it is possible to +use @code{git config} to disable listing files for a specific repository, +using: + +@example +git config set --local status.showUntrackedFiles no +@end example + +This does @strong{not} override the (if any) local value of this Lisp variable. +It also is not possible to use the Git variable to enable listing files +(in case the global value of this variable is nil). +@end defopt + +@defopt magit-status-file-list-limit +This option controls many files are listed at most in each section +that lists files in the status buffer. For performance reasons, it +is recommended that you do not increase this limit. +@end defopt -While the above function is a member of @code{magit-status-section-hook}, -the following functions by default are not. +While the above function is a member of @code{magit-status-section-hook} by +default, the following functions have to be explicitly added by the +user. Because that negatively affects performance, it is recommended +that you don't do that. @defun magit-insert-tracked-files -Insert a tree of tracked files. +Insert a list of tracked files. @end defun @defun magit-insert-ignored-files -Insert a tree of ignored files. +Insert a list of ignored files. @end defun @defun magit-insert-skip-worktree-files -Insert a tree of skip-worktree files. +Insert a list of skip-worktree files. @end defun @defun magit-insert-assumed-unchanged-files -Insert a tree of files that are assumed to be unchanged. +Insert a list of files that are assumed to be unchanged. @end defun @anchor{Status Log Sections} |