소스 검색

Merge pull request #3053 from ThomasWaldmann/update-docs-1.0

doc updates (1.0-maint)
TW 7 년 전
부모
커밋
81b058ab35
4개의 변경된 파일25개의 추가작업 그리고 1개의 파일을 삭제
  1. 5 0
      borg/archiver.py
  2. 1 1
      docs/development.rst
  3. 9 0
      docs/support.rst
  4. 10 0
      docs/usage.rst

+ 5 - 0
borg/archiver.py

@@ -1257,6 +1257,11 @@ class Archiver:
         change_passphrase_epilog = textwrap.dedent("""
         The key files used for repository encryption are optionally 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 = subparsers.add_parser('change-passphrase', parents=[common_parser],
                                           description=self.do_change_passphrase.__doc__,

+ 1 - 1
docs/development.rst

@@ -292,7 +292,7 @@ Checklist:
 - announce on:
 
  - Mailing list
- - Twitter (follow @ThomasJWaldmann for these tweets)
+ - Twitter
  - IRC channel (change ``/topic``)
 
 - 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
 <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
 ------------------------
 

+ 10 - 0
docs/usage.rst

@@ -832,6 +832,16 @@ a new repository when changing chunker params.
 
 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
 ~~~~~~~