Antoine Beaupré
a062e8f821
update documentation to follow changes
2015-11-24 12:07:57 -05:00
TW
d1377e5e15
Merge pull request #445 from anarcat/status-bug
...
add test for the weird unchanged file status
2015-11-24 18:04:09 +01:00
Thomas Waldmann
a8227aeda0
update CHANGES
2015-11-24 17:38:12 +01:00
Antoine Beaupré
48bb4c326d
cross-reference the status oddity in the usage
2015-11-23 19:48:33 -05:00
Antoine Beaupré
af7b17960e
clarify documentation on the A status oddity
2015-11-23 19:44:54 -05:00
Thomas Waldmann
25140e8c82
add --log-level to set the level of the builtin logging configuration, fixes #426
2015-11-21 02:09:16 +01:00
Thomas Waldmann
c4dae52ca4
configure logging via env var, use LazyLogger
...
logging.raiseExceptions not needed any more for py >= 3.2
2015-11-21 01:14:07 +01:00
Thomas Waldmann
42e9a77f5b
style changes of previous changeset did not work on rtd, try 2
2015-11-20 19:32:04 +01:00
Thomas Waldmann
077bcd0cde
logo: have a separate, bigger logo (do not reuse the favicon)
...
currently just scaled up / converted to png from the favicon.ico.
2015-11-20 19:06:40 +01:00
Thomas Waldmann
87bb886705
rtd theme adjustment: borg darkness for the upper left corner
2015-11-20 18:51:11 +01:00
Thomas Waldmann
7a08368b65
fix html_theme_path overriding previous definition of it
2015-11-20 17:56:35 +01:00
Thomas Waldmann
57ffa4d648
more precise binary installation steps
2015-11-20 15:49:53 +01:00
Thomas Waldmann
67c85734ba
upgrade OS X FUSE to 3.0.9, update release todo docs
2015-11-20 01:12:31 +01:00
Thomas Waldmann
dcab7dd8a7
new mailing list borgbackup@python.org
...
also: remove mailing list and irc channel address from development docs,
it is enough to have this information on the main page and on the support page.
2015-11-18 15:40:23 +01:00
Thomas Waldmann
2e64c29e01
use ISO-8601 date and time format, fixes #375
2015-11-16 23:51:21 +01:00
Thomas Waldmann
559c8908c1
add FAQ entry about unexpected 'A' status for unchanged file(s), fixes #403
2015-11-16 21:30:16 +01:00
Thomas Waldmann
38472900af
add 'E' file status to docs
2015-11-16 15:38:06 +01:00
Antoine Beaupré
917236231f
correct ubuntu release number
2015-11-16 09:07:59 -05:00
Antoine Beaupré
3bbd3319a4
use 'distribution' more consistently
2015-11-15 22:43:08 -05:00
Antoine Beaupré
d78d6d60b1
turn distro list into a table, adding Debian, Ubuntu, OSX
2015-11-15 22:40:00 -05:00
Antoine Beaupré
2c3f3f1b07
install docs: don't use "from" twice
...
it always abstracts "pypi" and "github" away (technical words that are
not necessary). pip remains.
2015-11-15 22:20:07 -05:00
Thomas Waldmann
3a72fbe418
update CHANGES
2015-11-15 20:30:58 +01:00
Thomas Waldmann
0070ef0c4a
minor install docs fixes
2015-11-15 20:23:33 +01:00
TW
eefc137ec9
Merge pull request #412 from anarcat/install-docs-nitpick
...
Install docs nitpick
2015-11-15 20:19:17 +01:00
Thomas Waldmann
234a88bec6
avoid hidden import, make it easy for pyinstaller
...
this fixes #218 in an easier way so one doesn't have to type
--hidden-import=logging.config all the time when using pyinstaller.
2015-11-15 15:52:02 +01:00
Thomas Waldmann
d6b8de943b
add docs for item flags / status output, fixes #402
2015-11-15 14:32:19 +01:00
Antoine Beaupré
aa4c76872c
move pyinstaller mention out of heading
...
pyinstaller probably means nothing for most people, while standalone binary is more meaningful
2015-11-14 21:08:28 -05:00
Antoine Beaupré
a8d2c18fee
split packaging meta-info in a separate paragraph and link to github
2015-11-14 21:07:16 -05:00
Antoine Beaupré
9f8700e383
restructure install page headings
...
do not repeat "installation" all the time, and regroup git and pip under "from source"
also link to the sections in the summary
2015-11-14 21:03:38 -05:00
Thomas Waldmann
fd5ccadcac
update CHANGES
2015-11-14 23:48:44 +01:00
Antoine Beaupré
811c18dcd4
explain how to regenerate usage and API files and when
2015-11-13 10:46:13 -05:00
Antoine Beaupré
8e36075fe9
commit usage files directly into git
...
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.
those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.
see #384
2015-11-13 10:42:52 -05:00
Antoine Beaupré
f13dd6e579
completely remove have_cython() hack
...
this was making us require mock, which is really a test component and
shouldn't be part of the runtime dependencies. furthermore, it was
making the imports and the code more brittle: it may have been
possible that, through an environment variable, backups could be
corrupted because mock libraries would be configured instead of real
once, which is a risk we shouldn't be taking.
finally, this was used only to build docs, which we will build and
commit to git by hand with a fully working borg when relevant.
see #384 .
2015-11-13 10:40:53 -05:00
Thomas Waldmann
4a2e4ec683
update CHANGES
2015-11-08 17:10:18 +01:00
Thomas Waldmann
f48a5ae6a7
fix formatting issue in changes.rst
2015-11-08 02:17:37 +01:00
Thomas Waldmann
cd40ec280d
update CHANGES
2015-11-08 01:29:53 +01:00
Thomas Waldmann
303bed9d12
docs: minor development docs update
2015-11-07 15:17:40 +01:00
Thomas Waldmann
c34ef37516
CHANGES: some fixes, add compatibility notes
2015-11-06 22:04:37 +01:00
Thomas Waldmann
47fec587d4
updated CHANGES
2015-11-06 21:33:43 +01:00
Thomas Waldmann
b1eb784bd1
docs: add section about debug commands
2015-11-06 18:31:06 +01:00
Thomas Waldmann
6c1b765741
docs: group general stuff under 1 headline, fix another headline level
2015-11-06 18:22:30 +01:00
Thomas Waldmann
f6244f006e
docs: warn about not running out of space
2015-11-04 01:51:09 +01:00
Thomas Waldmann
bdf7dc65bd
docs: add example for rename
2015-11-02 20:53:04 +01:00
Thomas Waldmann
734dae80ef
improve chunker params docs, fixes #362
2015-11-02 19:47:09 +01:00
Thomas Waldmann
44083f7f73
updated CHANGES
2015-10-29 16:22:02 +01:00
Thomas Waldmann
b787ac6ea1
docs: remove api docs (too much breakage on rtd)
2015-10-27 20:46:57 +01:00
Thomas Waldmann
a16ae01289
borgbackup install+basics presentation(asciinema + script)
2015-10-24 23:40:51 +02:00
Thomas Waldmann
39fb9b176a
update docs about return codes
2015-10-22 01:40:34 +02:00
TW
a1f88c73aa
Merge pull request #322 from anarcat/docs
...
explicitely commit to the units standard
2015-10-21 15:30:23 +02:00
Antoine Beaupré
76c0804bd5
explicitely commit to the units standard, see #289
2015-10-21 09:25:46 -04:00
Antoine Beaupré
03d381c2f9
describe the current style guide in documentation
2015-10-20 14:43:49 -04:00
Thomas Waldmann
a4f136afba
update CHANGES.rst (add issue / PR numbers)
2015-10-20 16:23:23 +02:00
Thomas Waldmann
344a25c102
update CHANGES.rst
2015-10-20 15:52:22 +02:00
Antoine Beaupré
de9e9d14b7
soften environment security warning to a note, and cross-ref to avoid dupe
2015-10-19 16:25:24 -04:00
Antoine Beaupré
c7c02ef725
fix path to favicon
2015-10-19 12:15:39 -04:00
Antoine Beaupré
5cd5fa72f6
warn users about the environment on multi-user systems
2015-10-19 11:29:22 -04:00
Antoine Beaupré
3d906ab731
word-wrap a bullet list as paragraphs instead
...
it looks nicer that way
2015-10-19 11:17:10 -04:00
Antoine Beaupré
b122fca580
use titles instead of definitions in FAQ
...
this way the titles show up in the table of contents and we can link
to individual entries
2015-10-19 11:12:14 -04:00
Antoine Beaupré
500c2a8a20
fix warnings in docs generation
2015-10-19 11:09:28 -04:00
Antoine Beaupré
780a7d816a
remove mention of "borg" in changelog title
...
we know what we are looking at already...
also demote the attic changelog so it doesn't show in the main table
of contents.
2015-10-19 11:08:19 -04:00
Thomas Waldmann
908e944bdd
include the help offered by borg help <topic> in the usage docs, fixes #293
...
it's not pretty yet, but better than nothing.
2015-10-17 21:53:09 +02:00
TW
0e9c524266
Merge pull request #292 from anarcat/rename-usage
...
add missing rename usage to docs, closes #279
2015-10-17 20:06:23 +02:00
Jakob Schnitzer
7cc3becad9
docs: restructure installation.rst, add OSX instructions
...
Moved the list of dependencies to the corresponding subsection.
Collected all preparation steps under one heading.
Added link to the Arch Linux AUR package.
Install docs for OS X.
2015-10-17 18:40:15 +02:00
Antoine Beaupré
e6c2359a60
add missing rename usage to docs, closes #279
2015-10-17 12:13:59 -04:00
Thomas Waldmann
e7f25d7821
docs: use zlib,6 compression in some examples, fixes #275
...
This is what attic used by default, but borgbackup defaults to "no compression".
I just adjusted the command invocation, so we can keep the example output
(which shows that stuff was compressed).
Also: add FAQ item about compression.
2015-10-16 01:18:37 +02:00
Jakob Schnitzer
da926f2eb4
docs: fix code blocks in installation.rst
...
In one case removed the |project_name| and |git_url| variables to fix
the display of the code block. Shouldn't be problematic, as they are not
used consistently in this document anyway.
Put two notes in their own nice '.. note::' blocks.
2015-10-13 17:25:52 +02:00
Jakob Schnitzer
fb62435fc6
docs: remove 'Additional Notes' from TOC, fix markup
...
What's covered in the 'Additional Notes' section of the documentation
hardly seems important enough to deserve its own entry in the sidebar.
2015-10-13 16:50:27 +02:00
Jakob Schnitzer
b42bbc6f68
docs: fix code blocks
2015-10-13 16:31:25 +02:00
Antoine Beaupré
256f89e697
add back logo, see #272
...
it's ugly as hell, but at least we have some logo there. keeping the issue opened for improvements
2015-10-13 08:35:12 -04:00
Antoine Beaupré
6b604ac28c
Merge remote-tracking branch 'origin/master' into rtd-theme
...
Conflicts:
README.rst
2015-10-12 23:29:45 -04:00
Antoine Beaupré
e59045fd24
move links from the sidebar to the readme
...
it seems sidebar links are not supported by the RTD theme just yet: https://github.com/snide/sphinx_rtd_theme/issues/254
2015-10-12 23:27:59 -04:00
Antoine Beaupré
3c535b9d7a
switch to default rtd theme
...
this still doesn't quite work: our sidebar is gone, so no more useful
links and related projects. we also loose the link to github and the
RTD popup, although the latter still needs to be confirmed on RTD
infra
2015-10-09 16:09:27 -04:00
Antoine Beaupré
da2ec7995f
fix homepage URL in all remaining places
...
we update the documentation to mention the automatic updates, and also
remove the hack in the makefile to update the github.io pages, which
are gone.
2015-10-09 15:54:04 -04:00
anarcat
80f82efcdf
Merge pull request #262 from anarcat/rtfd-fixup
...
fix build on readthedocs.org
2015-10-08 16:54:44 -04:00
Antoine Beaupré
7ba4d47f6e
clarify the class name part
2015-10-08 15:31:46 -04:00
Antoine Beaupré
2f803b6489
fix typo, split sentence
2015-10-08 15:31:46 -04:00
anarcat
1c997ea169
Merge pull request #261 from anarcat/docs-readme
...
bunch of docs reshuffling
2015-10-08 09:00:10 -04:00
Antoine Beaupré
6f9e04bc21
generalise the cython check hack
...
instead of applying this only to usage generation, use it as a generic
mechanism to disable loading of Cython code.
it may be incomplete: there may be other places where Cython code is
loaded that is not checked, but that is sufficient to build the usage
docs. the environment variable used is documented as such in the
docs/usage.rst.
we also move the check to a helper function and document it
better. this has the unfortunate side effect of moving includes
around, but I can't think of a better way.
2015-10-08 08:56:02 -04:00
Antoine Beaupré
da02f373c7
Revert "main website becomes RTD, main website link is pointless"
...
Instead, we put the readthedocs.org site as main website.
This reverts commit 8fe56f001c
.
2015-10-08 08:24:57 -04:00
Antoine Beaupré
8fe56f001c
main website becomes RTD, main website link is pointless
2015-10-07 21:10:09 -04:00
Antoine Beaupré
13d3568548
move usage generation to setup.py
...
this is an unfortunate rewrite of the manpage creation code mentionned
in #208 . ideally, this would be rewritten into a class that can
generate both man pages and .rst files.
2015-10-07 21:07:15 -04:00
Antoine Beaupré
4787424a66
move API generation to setup.py
2015-10-07 19:58:24 -04:00
Antoine Beaupré
60afc03d33
move authors to a stub, include LICENSE
2015-10-07 18:33:31 -04:00
Antoine Beaupré
60d04b05a0
show the README on the homepage
...
instead of a boring table of contents, try to show our more exciting README file
it's still a wall of text, but at least all the buzzwords and highlights are there
ideally, the table of contents would be in the sidebar, but i don't know how to do that
2015-10-07 17:56:24 -04:00
Antoine Beaupré
715a25802e
fix syntax errors in changelog
2015-10-07 17:54:43 -04:00
Antoine Beaupré
b87be856f9
include authors, and move to docs
...
also keep a symlink for backwards compatibility
2015-10-07 17:54:43 -04:00
Antoine Beaupré
3f2d3a8c93
remove unneeded rst boilerplate
...
include CHANGES.rst directly, use a symlink to keep backwards compat
2015-10-07 17:54:43 -04:00
Thomas Waldmann
047e003099
docs: more details about release process, reordered sections
2015-10-07 16:55:42 +02:00
Antoine Beaupré
cec8e18d2b
gpg can't sign multiple files at once, use a loop
2015-10-07 10:17:35 -04:00
Antoine Beaupré
48c8186592
detail what needs to happen in the github release
2015-10-07 10:16:07 -04:00
Antoine Beaupré
bb9b31e265
Revert "new proposal: formal release notes"
...
This reverts commit 4dca50fafa
.
Conflicts:
docs/development.rst
2015-10-07 10:12:56 -04:00
Antoine Beaupré
a49029db13
s/look/find/
2015-10-07 10:08:00 -04:00
Antoine Beaupré
ebe2e397f7
-them
2015-10-07 10:01:12 -04:00
Antoine Beaupré
74338f8a82
update where twitter is
2015-10-07 09:59:30 -04:00
Antoine Beaupré
d375a69689
fix rst formatting warnings
2015-10-07 09:54:40 -04:00
Antoine Beaupré
4dca50fafa
new proposal: formal release notes
...
this integrates the ideas in #214 to have a small checklist of things to send in the announcements on the mailing list and on the github release
2015-10-07 09:48:52 -04:00
Antoine Beaupré
2259bc050c
more reshuffling of release docs
...
mention that binaries should be signed
clarify where release milestones
reword all steps to be executive
2015-10-07 09:48:52 -04:00
Antoine Beaupré
ba0aeeb331
some fixes to the release engineering docs
...
link to the locations of different tools when I know them. i marked
the ones I don't know about specially so we can document those as
well.
point to the Github releases for the standalone binaries upload
2015-10-07 09:48:52 -04:00
Thomas Waldmann
04ac82d3e2
do binary releases via "github releases", closes #214
2015-10-07 15:41:17 +02:00
Thomas Waldmann
30bd38b51b
update linux glibc requirement (binaries built on debian7 now)
2015-10-07 15:08:09 +02:00
Thomas Waldmann
6299f2d02c
docs: pyinstaller 3.0 is released now
...
this or any later 3.x or git master checkout should work.
2015-10-07 03:42:08 +02:00
Thomas Waldmann
28a85bf0aa
update website sidebar link also
2015-10-06 21:53:20 +02:00
Thomas Waldmann
ee66c4c435
remove docs about binary wheels
...
we stop supporting them, because there are better alternatives:
- use a distribution package (from your linux distribution), if available
- use a pyinstaller binary provided by us (they include all you need in 1 file and
thus have better compatibility properties and are easier to install than a wheel)
- install from source (pypi or git) if everything else fails
2015-10-06 21:49:21 +02:00
Antoine Beaupré
a0ef4e25dd
add support for arbitrary SSH commands (attic#99)
...
while SSH options can be specified through `~/.ssh/config`, some users
may want to use a completely different SSH command for their backups,
without overriding their $PATH variable. it may also be easier to do
ad-hoc configuration and tests that way.
plus, the POLA tells us that users expects something like this to be
supported by commands that talk to ssh. it is supported by rsync, git
and so on.
2015-10-05 18:54:00 -04:00
Thomas Waldmann
bf3cf21ac5
docs: add warning about prune
2015-10-03 14:12:16 +02:00
TW
d27da99208
Merge pull request #230 from anarcat/api
...
add automatically generated API
2015-10-01 19:52:15 +02:00
Antoine Beaupré
a2cf0025c2
add automatically generated API
...
this is a crude hack for now, and could use a better table of contents
but at least we have some way of linking and showing the different
internal functions
the next phase here is obviously to document that API through the
addition of docstrings. a static api.rst could also be easier to read,
but maybe that could go through some docstrings as well, to be tested
2015-09-30 18:35:57 -04:00
Antoine Beaupré
b72d955c3e
remove api file introduced by mistake in #228
2015-09-30 18:33:45 -04:00
Antoine Beaupré
50e7d0f345
more human-readable output in usage generation
2015-09-30 17:42:18 -04:00
Antoine Beaupré
e3433f433c
generate usage include files only as needed
...
right now, the update_usage script regenerates the usage files at
every call
by moving this into the makefile, we make those files be generated
only when the source file change, which makes testing docs much faster
2015-09-30 17:30:56 -04:00
Thomas Waldmann
bc9679f0e5
development docs: update / fix / add Vagrant section
...
thanks to level323 for the vagrant docs
2015-09-30 17:38:51 +02:00
Thomas Waldmann
ba5fa0ba99
update / improve / reformat FAQ
...
- reduce redundancy (platforms are documented in README.rst)
- reformat to 80 chars width
- clarify checkpoints
- remove workarounds for stuff that was fixed
2015-09-30 17:13:22 +02:00
Thomas Waldmann
524ca297ea
document binary and non-binary requirements
2015-09-28 00:22:20 +02:00
Thomas Waldmann
86502d2729
docs: explain --read-special in more detail, fixes #220
2015-09-26 14:24:37 +02:00
Thomas Waldmann
22f335e0a0
docs: add how to build wheels and standalone binaries
2015-09-21 21:48:46 +02:00
Thomas Waldmann
7dbe2b80b3
docs: add a note about the single-file binaries
2015-09-21 21:28:18 +02:00
Thomas Waldmann
4410f1c3c3
docs: must run make html after tagging, so the html titel says correct version
2015-09-19 22:38:00 +02:00
Thomas Waldmann
688488d62d
docs: must run make html before release
2015-09-19 22:20:41 +02:00
Thomas Waldmann
0f68f1ccd1
add docs about release process
2015-09-19 21:35:02 +02:00
Thomas Waldmann
fb8d1cc602
also mention libattr
...
ACLs are implemented as xattrs, so libattr is pulled in as a dependency of libacl.
2015-09-19 20:31:26 +02:00
Thomas Waldmann
ff64b4c424
be more precise about OpenBSD/NetBSD support
...
xattrs/ACLs need platform specific code and new have none (yet) for them.
2015-09-16 11:53:53 +02:00
Thomas Waldmann
f138d06dd5
more platform support, works on py 3.5
...
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of
the platform-specific code.
2015-09-16 11:44:53 +02:00
Thomas Waldmann
cff7dffc95
detect lz4.h header file location
...
use similar code as for openssl headers
2015-09-12 19:38:38 +02:00
Thomas Waldmann
d74da7c031
llfuse 0.41 install troubles on some platforms, require < 0.41
...
UnicodeDecodeError exception due to non-ascii llfuse setup.py
2015-09-12 19:26:46 +02:00
Thomas Waldmann
e8f4fe0b88
pkg-config is needed for llfuse installation
2015-09-12 19:19:52 +02:00
TW
947fc095d8
Merge pull request #183 from ThomasWaldmann/borg-repo-envvar
...
BORG_REPO env var support
2015-09-06 21:51:24 +02:00
Thomas Waldmann
b3f5231bac
BORG_REPO env var support
...
sets the default repository to use, e.g. like:
export BORG_REPO=/mnt/backup/repo
borg init
borg create ::archive
borg list
borg mount :: /mnt
fusermount -u /mnt
borg delete ::archive
2015-09-06 18:18:24 +02:00
Thomas Waldmann
0b1035746e
read special files as if they were regular files, update docs, closes #79
...
do not use the files cache for such special files
2015-09-06 00:29:46 +02:00
Thomas Waldmann
2332ee433e
remove docs/misc/create_compression.txt
...
outdated - it just showed different levels of zlib compression,
but not we additionally have "lzma", "lz4" and "none" compression.
the "usage" and "internals" docs give some hints about them, too.
2015-08-29 13:35:58 +02:00
Thomas Waldmann
d2e5ce90f2
add FAQ entry about OS X commandline vs. HFS+ encoding issue, see #143 .
...
a real fix for this is in development, but needs some time.
2015-08-29 05:41:41 +02:00
Thomas Waldmann
1a949eab3e
docs: internals: improve structure and formatting
2015-08-29 04:23:57 +02:00
Thomas Waldmann
ddd0e2700b
docs: improve faq and support section
2015-08-29 04:16:03 +02:00
Thomas Waldmann
c823554b6b
docs: usage: improved formatting, cosmetic changes
2015-08-29 04:00:22 +02:00
Thomas Waldmann
e4dc482598
docs: quickstart: key modes, cosmetic changes
2015-08-29 03:39:53 +02:00
Thomas Waldmann
8a483511cb
docs: theme: use a lighter green
2015-08-29 03:01:39 +02:00
Thomas Waldmann
cebb61d8dd
docs: add pypi, wheel, dist package based install docs
2015-08-29 02:55:09 +02:00
Thomas Waldmann
79d7f49a44
docs: split install into system-specific preparations and generic instructions
2015-08-29 01:17:19 +02:00
Thomas Waldmann
ee58d4f074
docs: be more specific about Debian/Ubuntu release
2015-08-29 00:45:54 +02:00
Thomas Waldmann
fdc18eb0a0
support docs: write some words about BountySource
2015-08-21 00:25:24 +02:00
Thomas Waldmann
2402a2269e
update docs about fakeroot
2015-08-20 23:39:40 +02:00
Thomas Waldmann
1e11e24fc4
document locking system
2015-08-20 22:37:38 +02:00
Per Guth
0926c2821f
docs: installation: korora/fedora -> lz4-devel
2015-08-17 17:10:37 +02:00
Per Guth
8cf0ead693
docs: added favicon.ico
2015-08-17 12:58:49 +02:00
Per Guth
1c7b5b23f4
minor change in copyright notice
2015-08-17 11:31:42 +02:00
Thomas Waldmann
1d16e7a37c
compression: update / refine docs
2015-08-15 15:45:15 +02:00
Thomas Waldmann
bf757738f7
Merge branch 'master' into compression
2015-08-14 23:24:04 +02:00
Thomas Waldmann
feff0f0c94
install docs: replace hack for llfuse with proper solution
...
found out why it could not install llfuse into virtual env: it always complained about
not being able to find fuse.pc - which is part of libfuse-dev / fuse-devel and was missing.
once one adds the fuse dev stuff, llfuse installs to virtual env without problems.
2015-08-12 03:15:44 +02:00
Thomas Waldmann
8b1d46caa4
docs: more about compression
2015-08-10 20:36:21 +02:00
Thomas Waldmann
8af3aa3397
merged master
2015-08-09 23:51:46 +02:00
Thomas Waldmann
822379048f
added some sidebar links
2015-08-09 22:32:14 +02:00