Thomas Waldmann
1d16e7a37c
compression: update / refine docs
2015-08-15 15:45:15 +02:00
Thomas Waldmann
8b1d46caa4
docs: more about compression
2015-08-10 20:36:21 +02:00
Thomas Waldmann
b5bdb52b6a
update internals doc about chunker params, memory usage and compression
2015-07-14 00:43:35 +02:00
Thomas Waldmann
b2f460d591
fix filenames used for locking, update docs about locking
2015-07-13 23:20:46 +02:00
Jan Bader
8de8073345
Improve wording
2015-07-02 23:23:45 +02:00
Jan Bader
028e12473d
Update internals to reflect new --compression argument
2015-07-02 23:21:28 +02:00
Thomas Waldmann
83f520cfbe
improve internals docs
2015-06-07 02:15:13 +02:00
Thomas Waldmann
cb5c9b63b3
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS
...
use borg instead attic except at the places where it was used:
- as toplevel package name, directory name, file name
- to refer to original attic
remove sphinx upload make command, will be replaced by github.io site later
remove references to binary downloads and linux packages for now
remove some software name references, fix grammar
use borgbackup rather than borg-backup (or borg) in URLs,
less name collision issues, better search results, no validity issues with "-"
2015-05-13 15:02:33 +02:00
anarcat
ecee5a0b51
PDKF is a key derivation function
...
do not use the word "encryption", as it is actually closer to "hashing" anyways.
2015-03-05 09:00:06 -05:00
anarcat
5f882e976d
clarify the index memory usage analysis
...
it seems I extracted that data from [this mailing list post][] which
in turn takes it from [this github comment][].
[this mailing list post]: http://librelist.com/browser/attic/2014/5/6/questions-and-suggestions-about-inner-working-of-attic/
[this github comment]: https://github.com/jborg/attic/issues/26#issuecomment-35439254
2015-03-05 08:57:52 -05:00
anarcat
0ba86357d7
clarify that 4095 bytes is not a typo
...
i am actually assuming this right now, i haven't double-checked
2015-03-05 08:51:26 -05:00
anarcat
87cb4a4813
expand on the chunk id hash mechanism
...
according to @ThomasWaldmann, the algorithm varies according to whether encryption is enabled.
2015-03-05 08:48:23 -05:00
anarcat
8f8a035e93
fix a bunch of typos
...
this should fix the comments identified as `typo` and other small quirks found by @ThomasWaldmann.
2015-03-05 08:41:48 -05:00
anarcat
b7718f044d
Update internals.rst
2014-12-17 10:11:02 -05:00
Antoine Beaupré
e80e6c4dbb
better titles
2014-12-16 10:59:12 -05:00
Antoine Beaupré
b7c26735f7
fix formatting issues
2014-12-16 10:59:02 -05:00
Antoine Beaupré
d58b6ddf28
fix reference errors and remove reference to source code
2014-12-16 10:55:03 -05:00
Antoine Beaupré
688ba109ef
reorder to be more logical and more gentle
2014-12-16 10:35:53 -05:00
Antoine Beaupré
ddca3b856b
add a more gentle introduction
2014-12-16 10:30:57 -05:00
Antoine Beaupré
1fde2a9771
add more details on how encryption works
2014-12-16 10:20:52 -05:00
Antoine Beaupré
fd56bf0887
document the repo config file and more storage properties
...
again taken from the mailing list, mostly
2014-12-16 10:20:23 -05:00
Antoine Beaupré
3f27c367fe
document more internals, based on mailing list discussion
...
this should address #27 , #28 and #29 at least at a basic level
it is mostly based on the mailing list discussion mentionned in #27 ,
with some reformatting and merging of different posts.
2014-12-16 10:04:37 -05:00
Antoine Beaupré
9f0ed2a8c0
clarify some bits I missed
2014-12-16 10:03:20 -05:00
Antoine Beaupré
a8ab9c3445
document key files in a new Internals page
...
this is still incomplete as it only describes key files, but doesn't
clearly say how chunks are encrypted or decrypted.
this address parts of #29 but eventually that document should also
cover #27 , #28 and maybe #45
2014-12-16 09:10:34 -05:00