Browse Source

Merge pull request #3052 from ThomasWaldmann/doc-updates-1.1

doc updates (1.1-maint)
TW 7 years ago
parent
commit
f20576f50d
4 changed files with 26 additions and 1 deletions
  1. 1 1
      docs/development.rst
  2. 9 0
      docs/support.rst
  3. 11 0
      docs/usage/notes.rst
  4. 5 0
      src/borg/archiver.py

+ 1 - 1
docs/development.rst

@@ -340,7 +340,7 @@ Checklist:
 - announce on:
 - announce on:
 
 
  - Mailing list
  - Mailing list
- - Twitter (follow @ThomasJWaldmann for these tweets)
+ - Twitter
  - IRC channel (change ``/topic``)
  - IRC channel (change ``/topic``)
 
 
 - create a Github release, include:
 - create a Github release, include:

+ 9 - 0
docs/support.rst

@@ -38,6 +38,15 @@ unsubscribe and where you can find the archives of the list, see the
 `mailing list homepage
 `mailing list homepage
 <https://mail.python.org/mailman/listinfo/borgbackup>`_.
 <https://mail.python.org/mailman/listinfo/borgbackup>`_.
 
 
+Twitter
+-------
+
+Follow @borgbackup for announcements. You can also add @borgbackup if you
+would like to get retweeted for a borg related tweet.
+
+Please understand that Twitter is not suitable for longer / more complex
+discussions - use one of the other channels for that.
+
 Bounties and Fundraisers
 Bounties and Fundraisers
 ------------------------
 ------------------------
 
 

+ 11 - 0
docs/usage/notes.rst

@@ -50,6 +50,17 @@ a new repository when changing chunker params.
 For more details, see :ref:`chunker_details`.
 For more details, see :ref:`chunker_details`.
 
 
 
 
+``--noatime / --noctime``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can use these ``borg create`` options to not store the respective timestamp
+into the archive, in case you do not really need it.
+
+Besides saving a little space for the not archived timestamp, it might also
+affect metadata stream deduplication: if only this timestamp changes between
+backups and is stored into the metadata stream, the metadata stream chunks
+won't deduplicate just because of that.
+
 ``--umask``
 ``--umask``
 ~~~~~~~~~~~
 ~~~~~~~~~~~
 
 

+ 5 - 0
src/borg/archiver.py

@@ -2717,6 +2717,11 @@ class Archiver:
         change_passphrase_epilog = process_epilog("""
         change_passphrase_epilog = process_epilog("""
         The key files used for repository encryption are optionally passphrase
         The key files used for repository encryption are optionally passphrase
         protected. This command can be used to change this passphrase.
         protected. This command can be used to change this passphrase.
+
+        Please note that this command only changes the passphrase, but not any
+        secret protected by it (like e.g. encryption/MAC keys or chunker seed).
+        Thus, changing the passphrase after passphrase and borg key got compromised
+        does not protect future (nor past) backups to the same repository.
         """)
         """)
         subparser = key_parsers.add_parser('change-passphrase', parents=[common_parser], add_help=False,
         subparser = key_parsers.add_parser('change-passphrase', parents=[common_parser], add_help=False,
                                           description=self.do_change_passphrase.__doc__,
                                           description=self.do_change_passphrase.__doc__,