From c4d03f2407016bfac08f896493d3c24c5b8aa9c7 Mon Sep 17 00:00:00 2001 From: Zhao Li Date: Fri, 30 Aug 2019 15:37:17 -1000 Subject: [PATCH] note how to use toggle flag in README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 13a991da..92b6465d 100644 --- a/README.md +++ b/README.md @@ -329,6 +329,19 @@ Set `SCM_GIT_SHOW_STASH_INFO` to 'false' to **don't show** it: * `export SCM_GIT_SHOW_STASH_INFO=false` +### Ahead/Behind Count + +When displaying information regarding whether or not the local branch is ahead or behind it's remote counterpart, you can opt to display the number of commits ahead/behind. +This is useful if you only care whether or not you are ahead or behind and do not care how far ahead/behind you are. + +Set `SCM_GIT_SHOW_COMMIT_COUNT` to 'true' (the default value) to **show** the count of commits ahead/behind: + +* `export SCM_GIT_SHOW_COMMIT_COUNT=true` + +Set `SCM_GIT_SHOW_COMMIT_COUNT` to 'false' to **don't show** it: + +* `export SCM_GIT_SHOW_COMMIT_COUNT=false` + ### Git user In some environments, it is useful to know the value of the current git user, which is used to mark all new commits.