diff options
| author | Jonas Borgström <jonas@borgstrom.se> | 2014-02-04 23:49:10 +0100 |
|---|---|---|
| committer | Jonas Borgström <jonas@borgstrom.se> | 2014-02-05 00:04:30 +0100 |
| commit | faedaf8160a5487a6074faccb9f5a9793bd229a1 (patch) | |
| tree | 2c068872321bae5ab75d03c299fadf0a2bb8e079 /docs | |
| parent | b5037cf460a212129fd5378742e1fe3401acf5f6 (diff) | |
Basic repository consistency check functionality.
Still no archive metadata validation or repair functionality.
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/update_usage.sh | 2 | ||||
| -rw-r--r-- | docs/usage.rst | 6 | ||||
| -rw-r--r-- | docs/usage/check.rst.inc | 28 |
3 files changed, 35 insertions, 1 deletions
diff --git a/docs/update_usage.sh b/docs/update_usage.sh index 5a5eed31e..307d5ba79 100755 --- a/docs/update_usage.sh +++ b/docs/update_usage.sh @@ -2,7 +2,7 @@ if [ ! -d usage ]; then mkdir usage fi -for cmd in change-passphrase create delete extract info init list mount prune verify; do +for cmd in change-passphrase check create delete extract info init list mount prune verify; do FILENAME="usage/$cmd.rst.inc" LINE=`echo -n attic $cmd | tr 'a-z- ' '-'` echo -e ".. _attic_$cmd:\n" > $FILENAME diff --git a/docs/usage.rst b/docs/usage.rst index e7b134afc..9d5a97446 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -93,6 +93,12 @@ not corrupt. |project_name| will not compare the the archived files with the files on disk. +.. include:: usage/check.rst.inc + +The check command verifies the consistency of a repository. Any inconsistencies +found are reported to the standard error stream and the command will have a +non zero exit code. + .. include:: usage/delete.rst.inc This command deletes an archive from the repository. Any disk space not diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc new file mode 100644 index 000000000..08fd36193 --- /dev/null +++ b/docs/usage/check.rst.inc @@ -0,0 +1,28 @@ +.. _attic_check: + +attic check +----------- +:: + + + usage: attic check [-h] [-v] [--progress] [--no-progress] REPOSITORY + + Check repository consistency + + positional arguments: + REPOSITORY repository to check consistency of + + optional arguments: + -h, --help show this help message and exit + -v, --verbose verbose output + --progress Report progress status to standard output stream + --no-progress Disable progress reporting + + Progress status will be reported on the standard output stream by default when + it is attached to a terminal. Any problems found are printed to the standard + error stream and the command will have a non zero exit code. + +Description +~~~~~~~~~~~ + + |