Thalian
5cb8bd0dd0
[DOC] Add upgrade of tools to pip installation how-to
...
fixes #5090
2020-04-17 07:53:48 +02:00
Thomas Waldmann
6b3c7165aa
build_man
2020-04-12 19:55:57 +02:00
Thomas Waldmann
56c599e6dc
build_usage
2020-04-12 19:51:49 +02:00
TW
c867ebfeb6
Merge pull request #5048 from finefoot/patch-8
...
Option to bypass locking to use sensible borg commands with read-only repositories
2020-04-11 22:18:37 +02:00
finefoot
e49a17143d
Add option to bypass locking mechanism
2020-04-11 17:04:52 +02:00
Thalian
d0054f4482
[DOC] linked recommended restrictions to ssh public keys on borg servers in faq, #4946
...
fixes #4946
2020-04-08 03:02:50 +02:00
Thalian
25ab198d41
[DOCS] #4883 – Doc downplays severity of Nonce reuse issue ( #5082 )
...
docs: Borg documentation downplays severity of Nonce reuse issue, fixes #4883
2020-04-05 23:31:08 +02:00
TW
54df299604
Merge pull request #5034 from fantasya-pbem/docs/3428_Restore-after-corruption
...
docs: borg repo restore instructions needed, fixes #3428
2020-04-05 21:13:25 +02:00
Thomas Waldmann
7dc2a58a93
update CHANGES (master)
2020-04-05 21:00:39 +02:00
Thalian
1d9dadd6b7
[DOCS] #4883 – Borg documentation downplays severity of Nonce reuse issue
...
Shorten the log info for deleting/keeping security info. Fix bad wording.
2020-04-03 17:40:30 +02:00
Thomas Waldmann
888949c641
Improve description of path variables
...
Original commit by @finefoot, re-applied due to merge conflict.
2020-04-01 18:54:45 +02:00
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
df67b9ea11
[DOCS] #3428 – Borg repo restore instructions needed
...
Add new FAQ: A repo is corrupt and must be replaced with an older repo.
2020-03-25 19:56:51 +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
TW
e388fabd5b
Merge pull request #5057 from fantasya-pbem/docs/2929_Document-delete-data
...
[DOCS] #2929 – Document how to completely delete data
2020-03-22 22:01:50 +01:00
Thalian
abd81b2ebe
Fix broken indent of a list item
...
This prevents Sphinx WARNING: Bullet list ends without a blank line; unexpected unindent.
2020-03-22 15:17:21 +01:00
Thalian
a08b058fa0
[DOCS] #2929 – Document how to completely delete data
...
Add new FAQ entry that lists two ways how to really delete files from archives.
fixes #2929
2020-03-20 21:28:40 +01:00
TW
d832c6447c
Merge pull request #5045 from fantasya-pbem/docs/5000_Add-rendering-changes
...
docs: add "rendering docs" to release todo, fixes #5000
2020-03-20 17:02:13 +01:00
Thalian
19563b968e
[DOCS] #4587 – Make Sphinx warnings break docs build
...
Improve / clean up to trigger CI tests again.
2020-03-20 12:01:52 +01:00
Thalian
a8ecec24c2
[DOCS] #5000 – Add rendering docs to release todo
...
Add a line regarding checking the markup.
2020-03-18 19:54:03 +01:00
Thalian
19aa9825a8
[DOCS] #4587 – 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
6990feadb6
[DOCS] #4587 – Make Sphinx warnings break docs build
...
Remove blank line at top of file.
2020-03-16 19:06:00 +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
0359b97cce
[DOCS] #4587 – 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
Thalian
07c89cd794
[DOCS] #4941 – FAQ Borg config dir ( #5029 )
...
[DOCS] #4941 – How important is Borg config?
Add one FAQ with for $HOME/.config/borg, describing its content and how to take care of it.
Change "Default to" to "Defaults to".
Move TMPDIR to "Directories and files" section.
Add link to new FAQ for Borg config directory.
Add link to cache internals.
2020-03-16 00:17:46 +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
TW
c140dc995f
Merge pull request #5025 from milkey-mouse/reflow-docs
...
Reflow some really long lines in the docs
2020-03-12 02:23:07 +01:00
Milkey Mouse
f7f2493f75
docs: reflow some really long lines
...
I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and
reflowed them where reasonable. Line length in the docs isn't too important (it
doesn't matter once they're compiled), but it's nice not to have super-long
lines in one's editor.
2020-03-11 16:27:57 -07:00
TW
adf77e4f39
Merge pull request #5023 from milkey-mouse/fix-sphinx-warning
...
Suppress Sphinx lexer warnings in frontends.rst
2020-03-12 00:07:52 +01:00
Milkey Mouse
4e95ad6230
Add updating borgbackup.org/releases to release checklist ( fixes #4999 )
2020-03-11 15:51:29 -07: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
f74a3958e9
update changes.rst from 1.1-maint branch, fixes #5006
...
pre-1.1.11 advisory
changelogs of 1.1.10 and 1.1.11
2020-03-09 22:11:14 +01:00
Thomas Waldmann
a8831f4978
fix ProgressIndicator msgids, fixes #4935
...
add some to code, fix docs.
2020-03-03 23:57:36 +01:00
DifficultDerek
85928fe6ae
Update usage_general.rst.inc
...
- Added "Will move with BORG_CONFIG_DIR variable unless specified." to BORG_SECURITY_DIR info.
- put BORG_SECURITY_DIR immediately below BORG_CONFIG_DIR (and moved BORG_CACHE_DIR up before them).
2020-02-09 18:34:09 +01:00
finefoot
61b8234704
Add paragraph regarding cache security assumptions ( #4900 )
...
docs: tell about borg cache security precautions
2020-01-13 12:25:03 +01:00
Thalian
053b0db009
Add FAQ describing difference between a local repo vs. repo on a server.
...
Taken from a Q/A on the mailing list.
2019-12-23 13:13:08 +01:00
TW
66d86b6280
Merge pull request #4789 from ThomasWaldmann/regen-docs-man
...
ran python setup.py build_man
2019-11-02 13:53:58 +01:00
Thalian
a89539439e
#1552 Deployment Pull Backup ( #4804 )
...
docs: add a pull backup / push restore how-to, fixes #1552
2019-11-02 13:48:32 +01:00
Thomas Waldmann
451c4dd5de
build_man
2019-11-01 18:22:58 +01:00
TW
454dbfcaea
Merge pull request #4813 from Gu1nness/fix-borg-man-page
...
Fix the borg(1) man page creation
2019-11-01 18:09:15 +01:00
Rémi Oudin
5bdf998a21
Fix the borg(1) man page creation
...
Now the date is updated every time the page is regenerated.
2019-10-22 22:17:58 +02:00
Thalian
87abe5d927
Doc/4532 faq retain original paths ( #4794 )
...
More general FAQ for backup and retain original paths, fixes #4532
2019-10-20 16:51:06 +02:00
Thalian
f07bcb1387
[DOC] #3866 - Add FAQ for preventing SSH timeout in extract. ( #4782 )
...
Add FAQ for preventing SSH timeout in extract, fixes #3866
2019-10-19 21:19:17 +02:00
Thalian
21dc2b9ca0
[DOC] #4591 - Improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap).
2019-10-18 21:11:25 +02:00
Christian Paul
8be4007e1b
Fix typo: degress -> degrees
2019-09-30 23:57:18 +02:00
Ioannis Cherouvim
76a3dca3db
Typo fix (neccessary -> necessary).
2019-09-21 08:59:50 +03:00
Ioannis Cherouvim
b586a6a20e
docs: List items consistency
...
Capitalized list items and finished them with a full stop. This was inconsistent.
2019-09-20 21:19:38 +03:00
Thomas Waldmann
33862f5a50
build_man
2019-09-07 00:36:10 +02:00
Thomas Waldmann
102068bfeb
build_usage
2019-09-07 00:27:17 +02:00
Thomas Waldmann
75dcf93563
update CHANGES
2019-09-07 00:25:11 +02:00