Antoine Beaupré
5def2350d0
fix PDF rendering structure
...
without those changes, all of the toctree document headings do not
show up. they are considered to be "below" the last heading of the
README file.
we also remove the "Notes" section from the readme as there is only
one note, regarding the fork.
we introduce a stub "introduction" element in the toctree, otherwise
it is impossible for the PDF rendered to render the README correctly.
this is to workaround a bug in the PDF renderer.
2016-11-04 16:01:18 -04:00
Antoine Beaupré
18f3d64e4c
PDF docs: add logo and fix authors
...
the PDF documentation looks much better with those
2016-11-04 15:59:55 -04:00
Antoine Beaupré
7f9a147e46
move fork differences to FAQ
...
it seems now that the fork is more of historical value than a current
thing. people interested in the differences between borg and attic can
look in the FAQ, but I do not see why this is present in the README.
a new section regarding compatibility is created to keep that warning
in place.
2016-11-04 12:34:41 -04:00
Thomas Waldmann
84637322f2
ran build_usage
2016-10-29 01:58:21 +02:00
TW
89c31d6b44
Merge pull request #1763 from ThomasWaldmann/update-1.0-changes
...
update CHANGES (1.0-maint)
2016-10-29 01:44:39 +02:00
Thomas Waldmann
20f4a1f478
update CHANGES (1.0-maint)
2016-10-29 01:18:55 +02:00
Thomas Waldmann
a16c7d8e16
mention file://
2016-10-28 05:04:23 +02:00
Thomas Waldmann
11e9780393
quickstart: add a comment about other (remote) filesystems
2016-10-28 04:57:15 +02:00
Thomas Waldmann
e0298b2932
simplify quickstart
...
only give one possible ssh url syntax, all others are documented in usage chapter.
2016-10-28 04:51:46 +02:00
Thomas Waldmann
ca15cc80e5
document repo URLs / archive location
2016-10-28 04:43:33 +02:00
Thomas Waldmann
9b9179312d
ssh: repo url docs - fix typo
2016-10-28 03:32:37 +02:00
Florian Klink
88f7f8673d
docs/deployment.rst: do not use bare variables in ansible snippet
...
The current snippet throws deprecation warnings:
```
[DEPRECATION WARNING]: Using bare variables is deprecated. Update your
playbooks so that the environment value uses the full variable syntax
('{{auth_users}}').
This feature will be removed in a future
release. Deprecation warnings can be disabled by setting
deprecation_warnings=False in ansible.cfg.
```
2016-10-24 02:34:28 +02:00
Thomas Waldmann
c000eb8083
add clarification about append-only mode, fixes #1689
2016-10-19 02:31:39 +02:00
Thomas Waldmann
3550b24ed9
ran build_usage
2016-10-17 03:59:47 +02:00
Thomas Waldmann
b3133f6394
update api.rst
2016-10-17 03:58:22 +02:00
Thomas Waldmann
4d7af95ad2
update 1.0 CHANGES
2016-10-17 03:50:47 +02:00
Marian Beermann
573cb616d3
deployment: synthesize alternative --restrict-to-path example
2016-10-06 01:00:07 +02:00
Simon Heath
cf1c73b4f9
Added docs explaining multiple --restrict-to-path flags, with example (take 2)
2016-10-03 09:25:48 +02:00
enkore
ce72d24825
Clarify FAQ regarding backup of virtual machines ( #1672 )
2016-10-02 20:11:34 +02:00
Thomas Waldmann
a65707beb8
add more specific warning about write-access debug commands
2016-09-30 21:09:02 +02:00
Thomas Waldmann
e124f3c67b
update CHANGES
2016-09-29 17:16:57 +02:00
textshell
b84014e7d9
archiver: Add documentation for "key export" and "key import" commands. ( #1641 )
...
archiver: Add documentation for "key export" and "key import" commands
2016-09-27 15:24:31 +02:00
Martin Hostettler
4f9f25db02
development.rst: Add sphinx_rtd_theme to the sphinx install command
...
It’s used by default, so install it as well.
2016-09-25 21:45:15 +02:00
Stefano Probst
deadc81729
Fix inconsistency in FAQ
...
The script in the FAQ is named pv-wrapper. But in the variable export pv-wrapper.sh was used.
2016-09-17 09:14:01 +02:00
Thomas Waldmann
b2e389e0a0
docs: add contribution guidelines
2016-09-08 19:40:32 +02:00
Thomas Waldmann
f70008238a
link reference docs and faq about BORG_FILES_CACHE_TTL, fixes #1561
2016-09-03 19:23:59 +02:00
sven
248ccf0149
Update borg.css
2016-08-23 15:01:39 +02:00
Thomas Waldmann
a7c370b5ed
add debug-info usage help file
2016-08-21 23:37:07 +02:00
Carlo Teubner
1c666222a7
internals.rst: fix typos
2016-08-21 00:15:56 +02:00
Thomas Waldmann
f32c8858ad
update CHANGES with description of issue #1428
2016-08-18 23:22:50 +02:00
Thomas Waldmann
2aae0b17c6
update CHANGES
2016-08-18 22:15:30 +02:00
Thomas Waldmann
e3c155e75a
use a clean repo to test / build the release
2016-08-15 15:41:24 +02:00
enkore
17aacb9719
Fix changes.rst formatting, clarify changelog
2016-08-13 10:18:41 +02:00
Thomas Waldmann
07b47ef4a5
update CHANGES
2016-08-13 02:23:40 +02:00
TW
00449ad7b0
Merge pull request #1470 from ThomasWaldmann/document-archive-limit
...
document archive limitation, #1452
2016-08-13 00:12:17 +02:00
TW
4e5b80bbd5
Merge pull request #1464 from ThomasWaldmann/fix-xattr-exception
...
xattr: dynamically grow result buffer until it fits, fixes #1462
2016-08-12 18:21:59 +02:00
Thomas Waldmann
3c7dddcb99
update changelog
2016-08-12 18:00:50 +02:00
Thomas Waldmann
c834b2969c
document archive limitation, #1452
2016-08-12 17:54:15 +02:00
Thomas Waldmann
6e658a5a6c
docs: improve prune examples
2016-08-10 15:45:57 +02:00
Thomas Waldmann
a360307938
repo: do not put objects that we won't get, fixes #1451
...
we will not get() objects that have a segment entry larger than MAX_OBJECT_SIZE.
thus we should never produce such entries.
also: introduce repository.MAX_DATA_SIZE that gives the max payload size.
2016-08-09 18:05:22 +02:00
Thomas Waldmann
6c1c87f7ae
add forgotten usage help file from build_usage
2016-08-06 01:28:02 +02:00
Thomas Waldmann
a56b010960
ran build_usage
2016-08-05 20:26:09 +02:00
Thomas Waldmann
5b575f69dc
CHANGES: add date to 1.0.7rc1
2016-08-05 20:23:47 +02:00
Thomas Waldmann
b79e913244
update CHANGES
2016-08-05 19:56:10 +02:00
Robert Marcano
bc6050bc3c
Add backup using stable filesystem names recommendation
2016-08-03 22:54:51 -04:00
Thomas Waldmann
8e222d8fd9
glibc compatibility: add FAQ entry, fixes #491
2016-07-31 14:42:34 +02:00
Thomas Waldmann
5f7b466969
implement BORG_FILES_CACHE_TTL, update FAQ
...
raise default ttl to 20 (previously: 10).
2016-07-31 01:33:46 +02:00
Thomas Waldmann
4e737cb64b
OS X: install pkg-config to build with FUSE support
2016-07-30 21:08:20 +02:00
TW
9f996da640
Merge pull request #1380 from jzacsh/document-envvars-pitfalls
...
doc: quickstart on shell pitfalls for env. vars
2016-07-28 20:18:32 +02:00
Jonathan Zacsh
1eaf1b7365
follow automation quickstart w/env. var pitfalls
...
Mostly commentary on proper `export` usage, pitfall w/sudo, and debugging tips.
2016-07-28 14:10:28 -04:00
