aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Jon Bernard <jbernard@jbernard.io> 2018-09-22 09:45:56 -0400
committerGravatar Jon Bernard <jbernard@jbernard.io> 2018-09-22 09:45:56 -0400
commit5995718f0a60b58da9f3afa778a96daba95f4305 (patch)
tree30db51194c2998426688960d862ff3aa1366e393
parent135e9ca13e5476450047a88114497d430112cd15 (diff)
downloaddotfiles-5995718f0a60b58da9f3afa778a96daba95f4305.tar.gz
dotfiles-5995718f0a60b58da9f3afa778a96daba95f4305.tar.bz2
dotfiles-5995718f0a60b58da9f3afa778a96daba95f4305.zip
Add better explanation of state information
-rw-r--r--dotfiles/cli.py13
1 files changed, 12 insertions, 1 deletions
diff --git a/dotfiles/cli.py b/dotfiles/cli.py
index ffcbdbf..a24e38d 100644
--- a/dotfiles/cli.py
+++ b/dotfiles/cli.py
@@ -113,7 +113,18 @@ def status(repos, all, color):
Legend:
- ?: missing !: conflict E: error"""
+ ?: missing !: conflict E: error
+
+ Meaning:
+
+ * Missing: A dotfile in the repository is not present in your home
+ directory.
+
+ * Conflict: A dotfile in the repository is different from the file
+ in your home directory.
+
+ * Error: A dotfile expected in the repository is not present. You
+ should never see this."""
state_info = {
'error': {'char': 'E', 'color': None},