From: Rob Browning Date: Mon, 18 Jan 2016 00:53:18 +0000 (-0600) Subject: bup-index.md: fix path ref; update description X-Git-Tag: 0.28-rc1~14 X-Git-Url: https://arthur.barton.de/gitweb/?p=bup.git;a=commitdiff_plain;h=e0fa399f5a232f5c788bf1f0e7025b8c28327433 bup-index.md: fix path ref; update description Change one more "filename" to "path", and adjust the initial description. Signed-off-by: Rob Browning --- diff --git a/Documentation/bup-index.md b/Documentation/bup-index.md index accbfec..a70cd65 100644 --- a/Documentation/bup-index.md +++ b/Documentation/bup-index.md @@ -15,11 +15,10 @@ bup index \<-p|-m|-s|-u|\--clear|\--check\> [-H] [-l] [-x] [\--fake-valid] # DESCRIPTION -`bup index` prints and/or updates the bup filesystem index, -which is a cache of the absolute paths, attributes, and sha-1 -hashes of each file and directory in the filesystem. The -bup index is similar in function to the `git`(1) index, and -can be found in `$BUP_DIR/bupindex`. +`bup index` manipulates the filesystem index, which is a cache of +absolute paths and their metadata (atttributes, SHA-1 hashes, etc.). +The bup index is similar in function to the `git`(1) index, and the +default index can be found in `$BUP_DIR/bupindex`. Creating a backup in bup consists of two steps: updating the index with `bup index`, then actually backing up the @@ -109,7 +108,7 @@ does, due to the accommodations described above. -s, \--status : prepend a status code (A, M, D, or space) before each - filename. Implies `-p`. The codes mean, respectively, + path. Implies `-p`. The codes mean, respectively, that a file is marked in the index as added, modified, deleted, or unchanged since the last backup.