1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 17:27:31 +00:00
Commit graph

141 commits

Author SHA1 Message Date
Thalian
41ecd1ae30 [DOCS] #3428 – Borg repo restore instructions needed
Adapt FAQ to the new delete option.
2020-03-26 20:02:31 +01:00
Thalian
08a7661e67 [FEATURE] #4489 – Deprecate --nobsdflags option
Replaced by --noflags. In internal data structure the key 'bsdflags' is kept for backwards compatibility.
2020-03-25 06:35:15 +01:00
Thalian
04a25ba108 [DOCS] #4587 – Make Sphinx warnings break docs build
Add blank line to prevent Sphinx warning "WARNING: Explicit markup ends without a blank line; unexpected unindent.".
2020-03-16 19:06:00 +01:00
Thalian
0b5bb8dfec [DOCS] #4073 – PlaceholderError not printed as JSON
Add a warning for --log-json option that parsing errors will always be printed as plain text.
2020-03-15 20:37:28 +01:00
Milkey Mouse
1edf587bf3
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 15:33:44 -07:00
Thomas Waldmann
a8831f4978 fix ProgressIndicator msgids, fixes #4935
add some to code, fix docs.
2020-03-03 23:57:36 +01:00
Alexandr Kozlinskiy
b780c36811 docs: fix spelling errors 2019-03-11 22:40:03 +01:00
Thomas Waldmann
7f46eb99aa update docs about fixed chunker and chunker algo spec needed 2019-02-13 06:30:13 +01:00
Thomas Waldmann
fc6e81c8bb 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.
2018-12-07 01:18:32 +01:00
Thomas Waldmann
e6fcf4ea42 update docs about separated compaction 2018-07-14 14:53:23 +02:00
Thomas Waldmann
8ac272f35f security: describe chunk size / proximity issue, see #3687 2018-03-23 17:54:02 +01:00
TW
201c62430a
Merge pull request #3675 from ThomasWaldmann/crypto-compression-docs
security docs: add about combining compression and encryption
2018-03-17 19:46:42 +01:00
TW
1473ea708c
Merge pull request #3526 from borgbackup/enkore-patch-1
sec docs: explicitly note what happens OUTSIDE the attack model
2018-03-09 18:49:32 +01:00
Thomas Waldmann
be8913a93c security docs: add about combining compression and encryption 2018-03-09 18:02:57 +01:00
Alexander 'Leo' Bergolth
74c10e4643 add chunker_params to archive info (at least to json output) 2018-01-25 21:02:39 +01:00
enkore
674ce72fda sec docs: explicitly note what happens OUTSIDE the attack model 2018-01-10 15:30:12 +01:00
TW
4b98393542
Merge pull request #3520 from pngwjpgh/doc/chunk-seed
Chunk seed is generated per /repository/
2018-01-10 07:26:26 +01:00
Gregor Kleen
1820e22c02 Chunk seed is generated per /repository/ 2018-01-09 18:17:46 +01:00
Gianfranco Costamagna
0980d6ac43 fixup allows one to, with suggestions from Dan Christensen 2018-01-03 15:54:52 +01:00
Gianfranco Costamagna
111a19f7fa fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
Josh Holland
95a05dbbf1
docs: Fix missing apostrophe 2017-12-22 21:44:12 +00:00
Thomas Waldmann
2588e50f0b readme / docs: mention zstd 2017-12-18 22:55:00 +01:00
Tom Denley
c6591a7c06 Correct usage of "fewer" in place of "less" 2017-11-11 11:21:45 +00:00
8bit
8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann
5e2de8ba67 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)
2017-10-01 00:52:32 +02:00
TW
133e847f8e document utf-8 locale requirement for json mode, #2273 (#3009) 2017-09-08 08:31:51 +02:00
Marian Beermann
10a7b6b727 docs/internals: note segment size limitation 2017-08-22 17:48:48 +02:00
Marian Beermann
ab4981eff6 always use microseconds for ISO 8601 output 2017-08-22 17:32:25 +02:00
Marian Beermann
a836f451ab one datetime formatter to rule them all
# Conflicts:
#	src/borg/helpers.py
2017-08-22 17:32:21 +02:00
Lukas Fleischer
0943b322e3 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.
2017-08-15 19:58:30 +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
enkore
a1fa1b7aec Merge pull request #2587 from enkore/docs/is-openssl
docs/security: OpenSSL usage
2017-06-02 16:29:05 +02:00
Marian Beermann
d51f2bbbae docs: quotas: local repo disclaimer
...
2017-06-02 14:50:51 +02:00
Marian Beermann
089224975b docs: quotas: clarify compatbility; only relevant to serve side
also cf. "Enforcing the quota":

  The quota is enforcible only if *all* :ref:`borg_serve` versions
  accessible to clients support quotas
2017-06-02 13:12:43 +02:00
Marian Beermann
b996afbc06 docs/security: used implementations; note python libraries 2017-06-02 13:07:31 +02:00
Marian Beermann
107e320a20 binaries: don't bundle libssl
ArchiverTestCaseBinary passes.
2017-06-02 13:00:28 +02:00
Marian Beermann
3c951df4cd docs/security: security track record of OpenSSL and msgpack 2017-06-02 12:21:59 +02:00
Marian Beermann
4edf77788d Implement storage quotas 2017-05-31 18:36:03 +02:00
Marian Beermann
f8c63f9a66 docs/data structures: add simple example compaction run 2017-05-22 13:19:18 +02:00
Marian Beermann
691c6adc04 docs/data structures: detail explanation of compaction 2017-05-22 12:34:52 +02:00
Marian Beermann
73123578ed docs/data structures: add chunk layout diagram 2017-05-21 16:40:10 +02:00
Marian Beermann
1418aeadad docs/frontends: use headlines - you can link to them 2017-05-05 15:52:34 +02:00
Marian Beermann
2a22f93e44 list: JSON lines output for archive contents 2017-05-05 15:49:56 +02:00
enkore
0021368163 Merge pull request #2447 from ThomasWaldmann/update-docs4
Update docs
2017-04-28 10:49:35 +02:00
Marian Beermann
e036ebc340 docs: installation: pre-install considerations, fix crossrefs
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
2017-04-28 10:40:21 +02:00
Thomas Waldmann
bf69b049e9 be clear about what buzhash is used for, fixes #2390
and want it is not used for (deduplication).

also say already in the readme that we use a cryptohash
for dedupe, so people don't worry.
2017-04-25 23:38:55 +02:00
Marian Beermann
d1738ec315 docs/security: reiterate that RPC in Borg does no networking 2017-03-13 16:29:32 +01:00
Marian Beermann
86867e5171 docs/security: counter tracking
Copied from #2266
2017-03-13 14:50:56 +01:00
Marian Beermann
cdb4df0885 --log-json: time property on most progress/log objects, remove is_prompt 2017-03-09 21:36:37 +01:00
Marian Beermann
e07a289e34 frontends.rst: it's "null" in json 2017-03-09 21:36:37 +01:00
Marian Beermann
e98b5b20df yes(): handle JSON output 2017-03-09 21:36:37 +01:00
Marian Beermann
abb0a20d4f list: files->items, clarifications 2017-03-01 16:58:06 +01:00
Marian Beermann
7cce650a38 json docs: rather complete error list 2017-02-28 12:46:26 +01:00
Marian Beermann
8e1edaf258 ArchiveFormatter: add "start" key for compatibility with "info" 2017-02-28 01:33:36 +01:00
Marian Beermann
51350953b0 json: examples 2017-02-28 01:33:36 +01:00
Marian Beermann
d327109604 json progress: emit info (current $something) 2017-02-28 01:33:36 +01:00
Marian Beermann
fcad0ddab4 pass msgid for common errors 2017-02-28 01:19:20 +01:00
Marian Beermann
d5515b6952 add msgid to progress output 2017-02-28 01:19:20 +01:00
Marian Beermann
6288c9f751 enhance JSON progress information
separate output types, extra information
2017-02-27 20:30:20 +01:00
Marian Beermann
9ed8e4b7a9 document JSON 2017-02-26 17:01:06 +01:00
Marian Beermann
1652525858 docs: clarify metadata kind, manifest ops 2017-02-22 15:29:33 +01:00
Marian Beermann
ecdf6ba25f docs: key enc: correct / clarify some stuff, link to internals/security 2017-02-22 00:21:14 +01:00
Marian Beermann
c03a7ad844 docs: datas: enc: 1.1.x mas different MACs 2017-02-22 00:21:14 +01:00
Marian Beermann
6b21d63086 docs: datas: enc: correct factual error -- no nonce involved there. 2017-02-22 00:21:14 +01:00
Marian Beermann
e5bbba573a docs: make internals.rst an index page
Subsections:

- Security
- Data structures and file formats
2017-02-22 00:21:14 +01:00