Merge pull request #1566 from ThomasWaldmann/improve-docs

misc docs improvements

README.rst

@@ -114,6 +114,22 @@ Now doing another backup, just to show off the great deduplication:
 
 For a graphical frontend refer to our complementary project `BorgWeb <https://borgweb.readthedocs.io/>`_.
 
+Checking Release Authenticity and Security Contact
+==================================================
+
+`Releases <https://github.com/borgbackup/borg/releases>`_ are signed with this GPG key,
+please use GPG to verify their authenticity.
+
+In case you discover a security issue, please use this contact for reporting it privately
+and please, if possible, use encrypted E-Mail:
+
+Thomas Waldmann <tw@waldmann-edv.de>
+
+GPG Key Fingerprint: 6D5B EF9A DD20 7580 5747  B70F 9F88 FB52 FAF7 B393
+
+The public key can be fetched from any GPG keyserver, but be careful: you must
+use the **full fingerprint** to check that you got the correct key.
+
 Links
 =====
 

borg/archiver.py

@@ -1344,6 +1344,15 @@ def build_parser(self, args=None, prog=None):
 
         info_epilog = textwrap.dedent("""
         This command displays some detailed information about the specified archive.
+
+        Please note that the deduplicated sizes of the individual archives do not add
+        up to the deduplicated size of the repository ("all archives"), because the two
+        are meaning different things:
+
+        This archive / deduplicated size = amount of data stored ONLY for this archive
+                                         = unique chunks of this archive.
+        All archives / deduplicated size = amount of data stored in the repo
+                                         = all chunks in the repository.
         """)
         subparser = subparsers.add_parser('info', parents=[common_parser],
                                           description=self.do_info.__doc__,

docs/faq.rst

@@ -356,6 +356,8 @@ those files are reported as being added when, really, chunks are
 already used.
 
 
+.. _always_chunking:
+
 It always chunks all my files, even unchanged ones!
 ---------------------------------------------------
 

docs/usage.rst

@@ -89,6 +89,7 @@ General:
     BORG_FILES_CACHE_TTL
         When set to a numeric value, this determines the maximum "time to live" for the files cache
         entries (default: 20). The files cache is used to quickly determine whether a file is unchanged.
+        The FAQ explains this more detailled in: :ref:`always_chunking`
     TMPDIR
         where temporary files are stored (might need a lot of temporary space for some operations)