Skip to content

Commit 69bba24

Browse files
authored
Improve docs on check (#181)
1 parent fa4fcbd commit 69bba24

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/source/usage.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ go to a **new, empty directory** and run: ::
132132

133133
where
134134

135-
* ``--hpss=<path to HPSS>`` specifies the destination path on the HPSS file system.
135+
* ``--hpss=<path to HPSS>`` specifies the destination path on the HPSS file system. If ``--hpss=none``,
136+
then ``zstash check`` will check the cache.
136137
* ``--workers=<num of processes>`` an optional argument which specifies the number of
137138
processes to use, resulting in checking being done in parallel.
138139
**Using a high number will result in slow downloads for each of the tars since your bandwidth is limited.**
@@ -181,6 +182,21 @@ You may need to reupload it via ``zstash create``.
181182
Please contact the zstash development team, we're working on
182183
identifying what causes these issues.
183184

185+
Example using ``--hpss=none``::
186+
187+
$ mkdir zstash_demo
188+
$ echo 'file0 stuff' > zstash_demo/file0.txt
189+
$ zstash create --hpss=none zstash_demo
190+
$ ls zstash_demo/
191+
file0.txt zstash
192+
$ ls zstash_demo/zstash/
193+
000000.tar index.db
194+
$ cd zstash_demo
195+
$ zstash check --hpss=none
196+
INFO: Opening tar archive zstash/000000.tar
197+
INFO: Checking file0.txt
198+
INFO: No failures detected when checking the files. If you have a log file, run "grep -i Exception <log-file>" to double check.
199+
184200
Example usage of ``--tars``::
185201

186202
# Starting at 00005a until the end

0 commit comments

Comments
 (0)