1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-05 11:08:26 +00:00
Commit graph

171 commits

Author SHA1 Message Date
Thalian
19563b968e [DOCS] – Make Sphinx warnings break docs build
Improve / clean up to trigger CI tests again.
2020-03-20 12:01:52 +01:00
Thalian
19aa9825a8 [DOCS] – Make Sphinx warnings break docs build
general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label".
To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels.
2020-03-16 19:22:59 +01:00
Thalian
0359b97cce [DOCS] – Make Sphinx warnings break docs build
Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive.
2020-03-16 19:06:00 +01:00
Ioannis Cherouvim
76a3dca3db Typo fix (neccessary -> necessary). 2019-09-21 08:59:50 +03:00
Thomas Waldmann
102068bfeb build_usage 2019-09-07 00:27:17 +02:00
ntova
627ca1376b Fix various code blocks in the docs ()
Fix various code blocks in the docs

- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.

- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Stefan Majewsky
fc2c92b054 add a push-style example to borg-create(1) ()
add a push-style example to borg-create docs

When I browsed the readthedocs and manpages while setting up Borg for
myself for the first time, I saw multiple hints that pushing backups via
SSH is supported (e.g. the existence of the `borg serve` command and the
`--rsh` option), but I never found a clear example. I only found
<https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls>
after being pointed to it by @ThomasWaldmann.

Therefore, an explicit example in the `borg create` documentation seems
appropriate. I put it next to the pull-style example using sshfs which
serves a similar usecase.
2019-08-09 22:46:57 +02:00
ntova
c2ae9673b4 docs: benchmark crud: clarify that space is used until compact 2019-07-28 15:29:44 +02:00
Tiago Donato
8db4106150
Update documentation of borg create
Corrects a mention of borg 1.1 as a future version.
2019-07-15 21:53:30 -05:00
Joachim Breitner
b86aaa606d
RST syntax fix in docs 2019-07-09 10:23:33 +02:00
Elmar Hoffmann
d2595065b4 fix spelling 2019-06-15 13:19:43 +02:00
Thomas Waldmann
dc8077acba remove superfluous whitespace in docs 2019-06-09 14:45:18 +02:00
Thomas Waldmann
3082b1f1eb compact: move --cleanup-commits description from examples to docs 2019-05-06 23:10:07 +02:00
Thomas Waldmann
1f527464ab build_usage 2019-04-22 18:00:28 +02:00
Mike
ef90cda43a Add "SSH Configuration" section ()
Add "SSH Configuration" section

Add "SSH Configuration" section to "borg serve" documentation, to outline ssh/sshd configuration to prevent borg serve keeping a lock on a repo in the event the ssh connection is abnormally disconnected.

In response to issues ,  and  (and probably others).
2019-04-08 21:10:26 +02:00
Thomas Waldmann
9c380405a2 build_usage 2019-03-21 21:11:18 +01:00
Thomas Waldmann
9507856049 build_usage 2019-03-11 00:11:16 +01:00
TW
d7c6399396
Merge pull request from milkey-mouse/append-only-docs-3504
Elaborate on append-only mode docs
2019-03-10 15:04:23 +01:00
Thomas Waldmann
7ad5290501 redo stale lock handling, fixes
drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed)

borg now always assumes it has a unique hostid - either automatically
from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
2019-03-04 21:07:05 +01:00
Thomas Waldmann
bece7e8090 build_usage 2019-02-24 20:39:42 +01:00
Milkey Mouse
cb2b86274e
Elaborate on append-only mode docs 2019-02-22 19:05:29 -08:00
Thomas Waldmann
7f46eb99aa update docs about fixed chunker and chunker algo spec needed 2019-02-13 06:30:13 +01:00
Thomas Waldmann
a8d52351bb update man pages / usage docs 2018-07-14 14:56:29 +02:00
Thomas Waldmann
e6fcf4ea42 update docs about separated compaction 2018-07-14 14:53:23 +02:00
Saurav Sachidanand
b3c1104760 Update docs on deleting multiple archives 2018-05-27 09:38:23 +05:30
infectormp
60f9849336 docs: Improve borg with-lock ()
docs: improve borg with-lock, link to FAQ
2018-04-19 15:29:47 +02:00
Thomas Waldmann
451b22ee51 docs: extend append-only repo rollback docs, fixes 2018-03-09 23:27:31 +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
Gianfranco Costamagna
1a74326b5a borg: fix typo: explicitely -> explicitly 2018-01-03 11:42:30 +01:00
Gregor Kleen
85fb38e2f3 Add placeholder for fqdn in reverse notation 2017-12-11 23:00:38 +01:00
Thomas Waldmann
ce92960c63 add auto-generated docs for borg config
also: move a bit upwards in the use docs
(cherry picked from commit 278ed640e9)
2017-12-09 13:43:36 +01:00
Thomas Waldmann
0eaec60384 docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00
Thomas Waldmann
91ff2f81a6 docs: move bsdflags tuning comments to notes docs section
the atime comments are already there.
2017-11-25 20:08:33 +01:00
Thomas Waldmann
f2a1539f25 docs: fix examples with problematic option placements, fixes
have options to the left OR to the right of all positional arguments,
but not on BOTH sides and not in between them.
2017-11-25 19:29:34 +01:00
Thomas Waldmann
73fac09dda build_usage (master)
also: add new borgfs.rst.inc
2017-11-25 14:35:52 +01:00
TW
c5dc75ae23
Merge pull request from milkey-mouse/borg-config-cmd
Add borg config command
2017-11-24 16:56:15 +01:00
Milkey Mouse
5b47cf6fa5
Add borg config command (fixes )
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.

Add tests for borg config

Add documentation for borg config

Change manual config edits -> borg config

There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
2017-11-23 14:51:54 -08:00
Milkey Mouse
17d5c794d3
Generate man page for borgfs (fixes ) 2017-11-10 11:25:19 -08:00
Thomas Waldmann
ed1a8b5cf1 add example showing --show-version --show-rc 2017-10-12 06:03:12 +02:00
Fabio Pedretti
bc42f58c04 use --format rather than --list-format in examples, the latter is
deprecated
2017-10-09 14:09:43 +02:00
Thomas Waldmann
d8766df998 docs: add note about metadata dedup and --no[ac]time, fixes 2017-09-22 23:08:33 +02:00
Thomas Waldmann
3f16d91fd3 docs: add auto compression example to borg create examples 2017-09-21 14:00:50 +02:00
Thomas Waldmann
0ec6c920b9 docs: add compressor names to be more clear 2017-09-21 04:28:35 +02:00
Thomas Waldmann
c88528512f fix docs: --compression lz4 is the default now, fixes 2017-09-21 04:26:52 +02:00
Marian Beermann
2ff4550d4b docs: tar: tarpipe example 2017-07-26 10:40:35 +02:00
Thomas Waldmann
43ecde1bde python setup.py build_usage 2017-07-23 17:12:01 +02:00
enkore
a61462693a docs: recreate: fix wrong "remove unwanted files" example 2017-07-21 11:51:46 +02:00
TW
26bc80f210 Merge pull request from takluyver/i2815
Use code markup for command line option headings
2017-07-15 17:01:05 +02:00
Thomas Kluyver
ae2a1b8135 Name backup directories with 'before-upgrade'
Closes gh-2811
2017-07-15 16:23:08 +02:00