doc about marking deleted gist

fix #7
weakish · Nov 9, 2013 · a7fd76c · a7fd76c
1 parent bb0fdb8
commit a7fd76c
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -76,6 +76,7 @@ Hint: `gister` will pass all arguments to gist as `gist -c -o -d description ...
 
 If you've edited your gists at `gist.github.com` or local machine, without pull/push changesets, you can sync all your gists via `gister sync`.
 
+If you've deleted your gists at `gist.github.com`, after `gister sync`, the directories of deleted gists at your local machine will be marked with a prefix `_`.
 
 ### search
 
@@ -99,6 +100,9 @@ Storage
  |-- gists.list # a list of all your gists (including meta info) 
  |-- repo # git repositories of your gists
  |-- tree # working directory of your gist repositories
+  |-- 123456 # an example of gist
+  |-- _123567890 # an example of gist which you have deleted on gist.github.com
+  |-- ...
  `-- .csearchindex # code search index
 
 

diff --git a/man/gister.1 b/man/gister.1
@@ -100,6 +100,9 @@ Hint: \fBgister\fR will pass all arguments to gist as \fBgist \-c \-o \-d descri
 .P
 If you\'ve edited your gists at \fBgist\.github\.com\fR or local machine, without pull/push changesets, you can sync all your gists via \fBgister sync\fR\.
 .
+.P
+If you\'ve deleted your gists at \fBgist\.github\.com\fR, after \fBgister sync\fR, the directories of deleted gists at your local machine will be marked with a prefix \fB_\fR\.
+.
 .SS "search"
 Search all of your gists:
 .
@@ -134,6 +137,9 @@ gister migrate
 |\-\- gists\.list # a list of all your gists (including meta info)
 |\-\- repo # git repositories of your gists
 |\-\- tree # working directory of your gist repositories
+ |\-\- 123456 # an example of gist
+ |\-\- _123567890 # an example of gist which you have deleted on gist\.github\.com
+ |\-\- \.\.\.
 `\-\- \.csearchindex # code search index
 .
 .fi

diff --git a/man/gister.1.html b/man/gister.1.html
diff --git a/man/gister.1.ronn b/man/gister.1.ronn
@@ -68,6 +68,8 @@ Hint: `gister` will pass all arguments to gist as `gist -c -o -d description ...
 
 If you've edited your gists at `gist.github.com` or local machine, without pull/push changesets, you can sync all your gists via `gister sync`.
 
+If you've deleted your gists at `gist.github.com`, after `gister sync`, the directories of deleted gists at your local machine will be marked with a prefix `_`.
+
 ### search
 
 Search all of your gists:
@@ -85,10 +87,14 @@ If you have used `gister <1.0.0`, then you need to run this command to migrate:
 STORAGE
 -------
 
+
  /path/to/your/gists
  |-- gists.list # a list of all your gists (including meta info) 
  |-- repo # git repositories of your gists
  |-- tree # working directory of your gist repositories
+  |-- 123456 # an example of gist
+  |-- _123567890 # an example of gist which you have deleted on gist.github.com
+  |-- ...
  `-- .csearchindex # code search index