소스 검색

get rid of some .borg, be consistent with the backup repo name and path

it's pretty useless to have .borg as a directory extension, especially
since there is a README in there stating that this is a borg repo.

conistency:
"backup" is always used as relative backup repository path
"/mnt/backup" is always used as absolute repository path
Thomas Waldmann 10 년 전
부모
커밋
35d06afd6b
6개의 변경된 파일52개의 추가작업 그리고 51개의 파일을 삭제
  1. 2 2
      README.rst
  2. 4 4
      attic/archiver.py
  3. 2 2
      attic/testsuite/helpers.py
  4. 3 3
      docs/index.rst
  5. 13 13
      docs/quickstart.rst
  6. 28 27
      docs/usage.rst

+ 2 - 2
README.rst

@@ -13,8 +13,8 @@ Easy to use
 ~~~~~~~~~~~
 Initialize backup repository and create a backup archive::
 
-    $ borg init /usbdrive/my-backup.borg
-    $ borg create -v /usbdrive/my-backup.borg::documents ~/Documents
+    $ borg init /mnt/backup
+    $ borg create -v /mnt/backup::documents ~/Documents
 
 Main features
 ~~~~~~~~~~~~~

+ 4 - 4
attic/archiver.py

@@ -435,17 +435,17 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
         Examples:
 
         # Exclude '/home/user/file.o' but not '/home/user/file.odt':
-        $ borg create -e '*.o' repo.borg /
+        $ borg create -e '*.o' backup /
 
         # Exclude '/home/user/junk' and '/home/user/subdir/junk' but
         # not '/home/user/importantjunk' or '/etc/junk':
-        $ borg create -e '/home/*/junk' repo.borg /
+        $ borg create -e '/home/*/junk' backup /
 
         # Exclude the contents of '/home/user/cache' but not the directory itself:
-        $ borg create -e /home/user/cache/ repo.borg /
+        $ borg create -e /home/user/cache/ backup /
 
         # The file '/home/user/cache/important' is *not* backed up:
-        $ borg create -e /home/user/cache/ repo.borg / /home/user/cache/important
+        $ borg create -e /home/user/cache/ backup / /home/user/cache/important
         '''
 
     def do_help(self, parser, commands, args):

+ 2 - 2
attic/testsuite/helpers.py

@@ -38,8 +38,8 @@ class LocationTestCase(AtticTestCase):
             "Location(proto='ssh', user='user', host='host', port=None, path='/some/path', archive='archive')"
         )
         self.assert_equal(
-            repr(Location('mybackup.borg::archive')),
-            "Location(proto='file', user=None, host=None, port=None, path='mybackup.borg', archive='archive')"
+            repr(Location('path::archive')),
+            "Location(proto='file', user=None, host=None, port=None, path='path', archive='archive')"
         )
         self.assert_equal(
             repr(Location('/some/absolute/path::archive')),

+ 3 - 3
docs/index.rst

@@ -13,9 +13,9 @@ Easy to use
 Initialize a new backup :ref:`repository <repository_def>` and create your
 first backup :ref:`archive <archive_def>` in two lines::
 
-    $ borg init /somewhere/my-repository.borg
-    $ borg create /somewhere/my-repository.borg::Monday ~/Documents
-    $ borg create --stats /somewhere/my-repository.borg::Tuesday ~/Documents
+    $ borg init /mnt/backup
+    $ borg create /mnt/backup::Monday ~/Documents
+    $ borg create --stats /mnt/backup::Tuesday ~/Documents
     Archive name: Tuesday
     Archive fingerprint: 387a5e3f9b0e792e91ce87134b0f4bfe17677d9248cb5337f3fbf3a8e157942a
     Start time: Tue Mar 25 12:00:10 2014

+ 13 - 13
docs/quickstart.rst

@@ -13,16 +13,16 @@ A step by step example
 
 1. Before a backup can be made a repository has to be initialized::
 
-    $ borg init /somewhere/my-repository.borg
+    $ borg init /mnt/backup
 
 2. Backup the ``~/src`` and ``~/Documents`` directories into an archive called
    *Monday*::
 
-    $ borg create /somewhere/my-repository.borg::Monday ~/src ~/Documents
+    $ borg create /mnt/backup::Monday ~/src ~/Documents
 
 3. The next day create a new archive called *Tuesday*::
 
-    $ borg create --stats /somewhere/my-repository.borg::Tuesday ~/src ~/Documents
+    $ borg create --stats /mnt/backup::Tuesday ~/src ~/Documents
 
    This backup will be a lot quicker and a lot smaller since only new never
    before seen data is stored. The ``--stats`` option causes |project_name| to
@@ -42,24 +42,24 @@ A step by step example
 
 4. List all archives in the repository::
 
-    $ borg list /somewhere/my-repository.borg
+    $ borg list /mnt/backup
     Monday                               Mon Mar 24 11:59:35 2014
     Tuesday                              Tue Mar 25 12:00:10 2014
 
 5. List the contents of the *Monday* archive::
 
-    $ borg list /somewhere/my-repository.borg::Monday
+    $ borg list /mnt/backup::Monday
     drwxr-xr-x user  group         0 Jan 06 15:22 home/user/Documents
     -rw-r--r-- user  group      7961 Nov 17  2012 home/user/Documents/Important.doc
     ...
 
 6. Restore the *Monday* archive::
 
-    $ borg extract /somwhere/my-repository.borg::Monday
+    $ borg extract /mnt/backup::Monday
 
 7. Recover disk space by manually deleting the *Monday* archive::
 
-    $ borg delete /somwhere/my-backup.borg::Monday
+    $ borg delete /mnt/backup::Monday
 
 .. Note::
     Borg is quiet by default. Add the ``-v`` or ``--verbose`` option to
@@ -74,7 +74,7 @@ The following example script backs up ``/home`` and
 of old archives::
 
     #!/bin/sh
-    REPOSITORY=username@remoteserver.com:repository.borg
+    REPOSITORY=username@remoteserver.com:backup
 
     # Backup all of /home and /var/www except a few
     # excluded directories
@@ -138,19 +138,19 @@ Remote repositories
 host is accessible using SSH.  This is fastest and easiest when |project_name|
 is installed on the remote host, in which case the following syntax is used::
 
-  $ borg init user@hostname:repository.borg
+  $ borg init user@hostname:backup
 
 or::
 
-  $ borg init ssh://user@hostname:port/repository.borg
+  $ borg init ssh://user@hostname:port/backup
 
 If it is not possible to install |project_name| on the remote host, 
 it is still possible to use the remote host to store a repository by
 mounting the remote filesystem, for example, using sshfs::
 
-  $ sshfs user@hostname:/path/to/folder /tmp/mymountpoint
-  $ borg init /tmp/mymountpoint/repository.borg
-  $ fusermount -u /tmp/mymountpoint
+  $ sshfs user@hostname:/path/to/folder /mnt
+  $ borg init /mnt/backup
+  $ fusermount -u /mnt
 
 However, be aware that sshfs doesn't fully implement POSIX locks, so
 you must be sure to not have two processes trying to access the same

+ 28 - 27
docs/usage.rst

@@ -22,13 +22,13 @@ Examples
 ::
 
     # Local repository
-    $ borg init /data/mybackuprepo.borg
+    $ borg init /mnt/backup
 
     # Remote repository
-    $ borg init user@hostname:mybackuprepo.borg
+    $ borg init user@hostname:backup
 
     # Encrypted remote repository
-    $ borg init --encryption=passphrase user@hostname:mybackuprepo.borg
+    $ borg init --encryption=passphrase user@hostname:backup
 
 
 .. include:: usage/create.rst.inc
@@ -38,17 +38,17 @@ Examples
 ::
 
     # Backup ~/Documents into an archive named "my-documents"
-    $ borg create /data/myrepo.borg::my-documents ~/Documents
+    $ borg create /mnt/backup::my-documents ~/Documents
 
     # Backup ~/Documents and ~/src but exclude pyc files
-    $ borg create /data/myrepo.borg::my-files   \
-        ~/Documents                               \
-        ~/src                                     \
+    $ borg create /mnt/backup::my-files   \
+        ~/Documents                       \
+        ~/src                             \
         --exclude '*.pyc'
 
     # Backup the root filesystem into an archive named "root-YYYY-MM-DD"
     NAME="root-`date +%Y-%m-%d`"
-    $ borg create /data/myrepo.borg::$NAME / --do-not-cross-mountpoints
+    $ borg create /mnt/backup::$NAME / --do-not-cross-mountpoints
 
 
 .. include:: usage/extract.rst.inc
@@ -58,16 +58,16 @@ Examples
 ::
 
     # Extract entire archive
-    $ borg extract /data/myrepo::my-files
+    $ borg extract /mnt/backup::my-files
 
     # Extract entire archive and list files while processing
-    $ borg extract -v /data/myrepo::my-files
+    $ borg extract -v /mnt/backup::my-files
 
     # Extract the "src" directory
-    $ borg extract /data/myrepo::my-files home/USERNAME/src
+    $ borg extract /mnt/backup::my-files home/USERNAME/src
 
     # Extract the "src" directory but exclude object files
-    $ borg extract /data/myrepo::my-files home/USERNAME/src --exclude '*.o'
+    $ borg extract /mnt/backup::my-files home/USERNAME/src --exclude '*.o'
 
 .. include:: usage/check.rst.inc
 
@@ -79,14 +79,14 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg list /data/myrepo
+    $ borg list /mnt/backup
     my-files            Thu Aug  1 23:33:22 2013
     my-documents        Thu Aug  1 23:35:43 2013
     root-2013-08-01     Thu Aug  1 23:43:55 2013
     root-2013-08-02     Fri Aug  2 15:18:17 2013
     ...
 
-    $ borg list /data/myrepo::root-2013-08-02
+    $ borg list /mnt/backup::root-2013-08-02
     drwxr-xr-x root   root          0 Jun 05 12:06 .
     lrwxrwxrwx root   root          0 May 31 20:40 bin -> usr/bin
     drwxr-xr-x root   root          0 Aug 01 22:08 etc
@@ -102,18 +102,18 @@ Examples
 ::
 
     # Keep 7 end of day and 4 additional end of week archives:
-    $ borg prune /data/myrepo --keep-daily=7 --keep-weekly=4
+    $ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4
 
     # Same as above but only apply to archive names starting with "foo":
-    $ borg prune /data/myrepo --keep-daily=7 --keep-weekly=4 --prefix=foo
+    $ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 --prefix=foo
 
     # Keep 7 end of day, 4 additional end of week archives,
     # and an end of month archive for every month:
-    $ borg prune /data/myrepo --keep-daily=7 --keep-weekly=4 --monthly=-1
+    $ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 --monthly=-1
 
     # Keep all backups in the last 10 days, 4 additional end of week archives,
     # and an end of month archive for every month:
-    $ borg prune /data/myrepo --keep-within=10d --keep-weekly=4 --monthly=-1
+    $ borg prune /mnt/backup --keep-within=10d --keep-weekly=4 --monthly=-1
 
 
 .. include:: usage/info.rst.inc
@@ -122,13 +122,13 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg info /data/myrepo::root-2013-08-02
+    $ borg info /mnt/backup::root-2013-08-02
     Name: root-2013-08-02
     Fingerprint: bc3902e2c79b6d25f5d769b335c5c49331e6537f324d8d3badcb9a0917536dbb
     Hostname: myhostname
     Username: root
     Time: Fri Aug  2 15:18:17 2013
-    Command line: /usr/bin/borg create --stats /data/myrepo::root-2013-08-02 / --do-not-cross-mountpoints
+    Command line: /usr/bin/borg create --stats /mnt/backup::root-2013-08-02 / --do-not-cross-mountpoints
     Number of files: 147429
     Original size: 5344169493 (4.98 GB)
     Compressed size: 1748189642 (1.63 GB)
@@ -141,7 +141,7 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg mount /data/myrepo::root-2013-08-02 /tmp/mymountpoint
+    $ borg mount /mnt/backup::root-2013-08-02 /tmp/mymountpoint
     $ ls /tmp/mymountpoint
     bin  boot  etc  lib  lib64  mnt  opt  root  sbin  srv  usr  var
     $ fusermount -u /tmp/mymountpoint
@@ -154,16 +154,17 @@ Examples
 ::
 
     # Create a key file protected repository
-    $ borg init --encryption=keyfile /tmp/encrypted-repo
-    Initializing repository at "/tmp/encrypted-repo"
+    $ borg init --encryption=keyfile /mnt/backup
+    Initializing repository at "/mnt/backup"
     Enter passphrase (empty for no passphrase):
     Enter same passphrase again: 
-    Key file "/home/USER/.borg/keys/tmp_encrypted_repo" created.
+    Key file "/home/USER/.borg/keys/mnt_backup" created.
     Keep this file safe. Your data will be inaccessible without it.
 
     # Change key file passphrase
-    $ borg change-passphrase /tmp/encrypted-repo
-    Enter passphrase for key file /home/USER/.borg/keys/tmp_encrypted_repo:
+    $ borg change-passphrase /mnt/backup
+    Enter passphrase for key file /home/USER/.borg/keys/mnt_backup:
     New passphrase: 
     Enter same passphrase again: 
-    Key file "/home/USER/.borg/keys/tmp_encrypted_repo" updated
+    Key file "/home/USER/.borg/keys/mnt_backup" updated
+