Commit graph

84 commits

Author SHA1 Message Date
Thomas Waldmann
879ea73aa7 recreate: remove extra confirmation
not experimental any more, user is responsible for avoiding bugs.
the docs still point out that this might be dangerous when used wrongly,
like it also does for prune.
2020-09-22 22:30:01 +02:00
Thomas Waldmann
d068f35fb4 fixup: s/functionality/function/ 2020-09-22 22:27:27 +02:00
Thomas Waldmann
c0d6c33a09 rephrase some warnings, fixes #5164
borg check --repair and borg recreate are now present in the code
since rather long, so they are not experimental any more.

but, both bear some risk of data loss:
- there could be an undiscovered bug in the code
- the user might use them wrong (e.g. accidentally excluding everything /
  not matching anything when recreating an archive)
- there might be kinds of corruption borg check --repair can not fix
  and it might make things even worse while trying to fix.

so, if your repo / archive(s) are important, be careful.
2020-09-22 22:23:17 +02:00
Thalian
63c43d55b5 docs: add security faq explaining AES-CTR crypto issues, fixes #5254 2020-07-25 17:58:16 +02:00
Thalian
b90a977ace [DOCS] #4587 – Make Sphinx warnings break docs build
Backport from master and some other fixes for Sphinx warnings.
2020-03-22 16:01:28 +01:00
Thalian
97c26c2af5 [DOCS] borgbackup#4073 – PlaceholderError not printed as JSON
Backport from master:
Add a warning for --log-json option that parsing errors will always be printed as plain text.
2020-03-15 21:28:21 +01:00
Milkey Mouse
bc97946a40
Suppress Sphinx lexer warnings in frontends.rst
Because some of the JSON blocks in frontends.rst included non-JSON
contents (user replies, etc.) the blocks didn't parse/highlight and
`make html` complained:

borg/docs/internals/frontends.rst:28: WARNING: Could not lex literal_block as "json".

There's no easy way to enable and disable highlighting just for
specific lines, but individually unsetting the highlight language per
block suppresses the warnings.
2020-03-11 16:34:53 -07:00
Thomas Waldmann
358ba5e591 fix ProgressIndicator msgids, fixes #4935
add some to code, fix docs.
2020-02-29 20:39:27 +01:00
Thomas Waldmann
c6fe7265c4 docs: --format is required for some expensive-to-compute values
borg list by default does not compute expensive values except when
they are needed. whether they are needed is determined by the format,
in standard mode as well as in --json mode.

(cherry picked from commit fc6e81c8bb)
2018-12-07 01:25:56 +01:00
Thomas Waldmann
f3465c7932 security: describe chunk size / proximity issue, see #3687
(cherry picked from commit 8ac272f35f)
2018-03-24 22:00:41 +01:00
Thomas Waldmann
0555fe4869 security docs: add about combining compression and encryption
(cherry picked from commit be8913a93c)
2018-03-17 21:11:15 +01:00
enkore
ac0b9fbdae sec docs: explicitly note what happens OUTSIDE the attack model
(cherry picked from commit 674ce72fda)
2018-03-17 21:09:13 +01:00
Gregor Kleen
183966549f Chunk seed is generated per /repository/ 2018-02-28 15:46:23 +00:00
Alexander 'Leo' Bergolth
42a9053771 add chunker_params to json docs 2018-01-22 09:05:24 +01:00
Josh Holland
9f7ed7fcec docs: Fix missing apostrophe
(cherry picked from commit 95a05dbbf1)
2017-12-23 17:47:00 +01:00
Thomas Waldmann
ce7864f6a6 readme / docs: mention zstd
(cherry picked from commit 2588e50f0b)
2017-12-20 03:25:04 +01:00
Tom Denley
8fb8692d42
Correct usage of "fewer" in place of "less" 2017-11-22 21:52:41 -08:00
Thomas Waldmann
eab9f5a07b implement files cache mode control, fixes #911
You can now control the files cache mode using this option:

--files-cache={ctime,mtime,size,inode,rechunk,disabled}*

(only some combinations are supported)

Previously, only these modes were supported:
- mtime,size,inode (default of borg < 1.1.0rc4)
- mtime,size (by using --ignore-inode)
- disabled (by using --no-files-cache)

Now, you additionally get:
- ctime alternatively to mtime (more safe), e.g.:
  ctime,size,inode (this is the new default of borg >= 1.1.0rc4)
- rechunk (consider all files as changed, rechunk them)

Deprecated:
- --ignore-inodes (use modes without "inode")
- --no-files-cache (use "disabled" mode)

The tests needed some changes:
- previously, we use os.utime() to set a files mtime (atime) to specific
  values, but that does not work for ctime.
- now use time.sleep() to create the "latest file" that usually does
  not end up in the files cache (see FAQ)

(cherry picked from commit 5e2de8ba67)
2017-10-01 01:27:18 +02:00
TW
a99060508f document utf-8 locale requirement for json mode, #2273 (#3009)
(cherry picked from commit 133e847f8e)
2017-09-08 21:12:46 +02:00
TW
1b7b58e712 Merge pull request #2964 from ThomasWaldmann/detect-attic-repos-1.1
Detect non-upgraded Attic repositories
2017-08-27 14:52:53 +02:00
Marian Beermann
d5697fb4a8 always use microseconds for ISO 8601 output
(cherry picked from commit ab4981eff6)
2017-08-25 04:20:06 +02:00
Marian Beermann
008571228f one datetime formatter to rule them all
(cherry picked from commit a836f451ab)
2017-08-25 04:00:26 +02:00
Lukas Fleischer
ff93b6b972 Detect non-upgraded Attic repositories
When opening a repository, always try to read the magic number of the
latest segment and compare it to the Attic segment magic (unless the
repository is opened for upgrading). If an Attic segment is detected,
raise a dedicated exception, telling the user to upgrade the repository
first.

Fixes #1933.

(cherry picked from commit 0943b322e3)
2017-08-25 03:30:31 +02:00
Zhuoyun Wei
f0de6a4c90
Doc: add warning about changing segments_per_dir values 2017-07-21 12:26:24 -04:00
Zhuoyun Wei
7d07a9629e
Doc: update default values in sample config file 2017-07-21 12:26:17 -04:00
Marian Beermann
d495b0fe75 docs: move introduction sentence 2017-06-19 10:01:55 +02:00
enkore
52da719d30 Merge pull request #2707 from narendravardi/master
Don't perform full Travis build on docs-only changes #2531
2017-06-19 09:58:41 +02:00
Marian Beermann
6e17ca7c3a docs: fix typo 2017-06-19 09:50:22 +02:00
Marian Beermann
8aa745ddbd create: --no-cache-sync 2017-06-18 02:01:26 +02:00
enkore
de00d9d822 Merge pull request #2602 from enkore/pr/2134.docs
internals: rewrite manifest & feature flags
2017-06-11 12:29:12 +02:00
Marian Beermann
bffcc60f90 docs: internals: feature flags typos, clarifications 2017-06-11 12:28:37 +02:00
Marian Beermann
f5e7d964cf docs: internals: feature flags set theory 2017-06-05 22:29:29 +02:00
Marian Beermann
e80c0f7c5e docs: fix way too small figures in pdf 2017-06-05 01:01:27 +02:00
Marian Beermann
da04aba5c5 docs: internals: feature flags introduction/rationale 2017-06-05 00:41:30 +02:00
Marian Beermann
c427d238f4 docs: internals: amend feature flags 2017-06-05 00:21:04 +02:00
Marian Beermann
f2fd6fc699 docs: internals: cache feature flags 2017-06-05 00:16:48 +02:00
Marian Beermann
36bdc9d15e internals: rewrite manifest & feature flags 2017-06-05 00:16:48 +02:00
Marian Beermann
19b425a5c8 docs: internals: more HashIndex details 2017-06-04 23:00:42 +02:00
Marian Beermann
cf77aa53d7 docs: internals: fix ASCII art equations 2017-06-04 22:50:17 +02:00
Marian Beermann
d33929a24d docs: internals: edited HashIndex 2017-06-04 22:44:29 +02:00
Marian Beermann
daae1cc515 docs/internals: layers image; Blimey! it's one pixel off! 2017-06-04 22:23:54 +02:00
Marian Beermann
a3815034e1 docs: internals: terms/glossary TODO 2017-06-04 22:17:59 +02:00
Marian Beermann
9174f84682 docs: internals: delete non-sequitor from repo/segments 2017-06-04 22:17:56 +02:00
Marian Beermann
89d8f54afb docs: internals: edited obj graph related sections a bit 2017-06-04 22:17:53 +02:00
Marian Beermann
2b0e7bc924 docs: data structures: demingle cache and repo index 2017-06-04 22:17:48 +02:00
Marian Beermann
f1709df8a9 docs/internals: layers image + description 2017-06-04 22:13:55 +02:00
enkore
d95551736d Merge pull request #2591 from enkore/issue/1101.design
docs: file integrity
2017-06-03 18:17:14 +02:00
Marian Beermann
da99ec2fbd docs: quotas: refer to --restrict-to-repository 2017-06-03 15:07:08 +02:00
Marian Beermann
b8e40fdce6 editing 2017-06-03 13:05:33 +02:00
Marian Beermann
45ee62e5ea docs: file integrity 2017-06-03 00:51:34 +02:00