From 50bb8a6dc10f6078f8c6b8cb7f6eb679895f441b Mon Sep 17 00:00:00 2001 From: Hong Xu Date: Thu, 3 Oct 2019 19:47:57 -0700 Subject: [PATCH] Add document for option treemacs-use-git-mode This option has been implemented but was not documented. --- layers/+filetree/treemacs/README.org | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/layers/+filetree/treemacs/README.org b/layers/+filetree/treemacs/README.org index e4ed95e0f..e29a6eb45 100644 --- a/layers/+filetree/treemacs/README.org +++ b/layers/+filetree/treemacs/README.org @@ -11,6 +11,7 @@ - [[#configuration][Configuration]] - [[#follow-mode][Follow mode]] - [[#file-watch][File watch]] + - [[#git-mode][Git mode]] - [[#collapsed-directories][Collapsed directories]] - [[#locking-width][Locking width]] - [[#key-bindings][Key bindings]] @@ -68,6 +69,19 @@ part of the file system shown by treemacs set the layer variable Default is =t=. +** Git mode +To enable Treemacs to check for files’ and directories’ git status information +and highlight them accordingly, set the layer variable =treemacs-use-git-mode= +to =simple=, =extended=, or =deferred=. See the [[https://github.com/Alexander-Miller/treemacs#git-mode][Treemacs doc]] for a more detailed +explanation. + +#+BEGIN_SRC emacs-lisp + (setq-default dotspacemacs-configuration-layers '( + (treemacs :variables treemacs-use-git-mode 'deferred))) +#+END_SRC + +Default is =nil=. + ** Collapsed directories *This feature requires python to be installed*.