summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)Author
2015-10-07move authors to a stub, include LICENSEAntoine Beaupré
2015-10-07show the README on the homepageAntoine Beaupré
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-07fix syntax errors in changelogAntoine Beaupré
2015-10-07include authors, and move to docsAntoine Beaupré
also keep a symlink for backwards compatibility
2015-10-07remove unneeded rst boilerplateAntoine Beaupré
include CHANGES.rst directly, use a symlink to keep backwards compat
2015-10-07gpg can't sign multiple files at once, use a loopAntoine Beaupré
2015-10-07detail what needs to happen in the github releaseAntoine Beaupré
2015-10-07Revert "new proposal: formal release notes"Antoine Beaupré
This reverts commit 4dca50fafab302622eb5c98e0f26a6b34abe8ca6. Conflicts: docs/development.rst
2015-10-07s/look/find/Antoine Beaupré
2015-10-07-themAntoine Beaupré
2015-10-07update where twitter isAntoine Beaupré
2015-10-07fix rst formatting warningsAntoine Beaupré
2015-10-07new proposal: formal release notesAntoine Beaupré
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-07more reshuffling of release docsAntoine Beaupré
mention that binaries should be signed clarify where release milestones reword all steps to be executive
2015-10-07some fixes to the release engineering docsAntoine Beaupré
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-07do binary releases via "github releases", closes #214Thomas Waldmann
2015-10-07update linux glibc requirement (binaries built on debian7 now)Thomas Waldmann
2015-10-07docs: pyinstaller 3.0 is released now0.27.0Thomas Waldmann
this or any later 3.x or git master checkout should work.
2015-10-06update website sidebar link alsoThomas Waldmann
2015-10-06remove docs about binary wheelsThomas Waldmann
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-05add support for arbitrary SSH commands (attic#99)Antoine Beaupré
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-03docs: add warning about pruneThomas Waldmann
2015-10-01Merge pull request #230 from anarcat/apiTW
add automatically generated API
2015-09-30add automatically generated APIAntoine Beaupré
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-30remove api file introduced by mistake in #228Antoine Beaupré
2015-09-30more human-readable output in usage generationAntoine Beaupré
2015-09-30generate usage include files only as neededAntoine Beaupré
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-30development docs: update / fix / add Vagrant sectionThomas Waldmann
thanks to level323 for the vagrant docs
2015-09-30update / improve / reformat FAQThomas Waldmann
- reduce redundancy (platforms are documented in README.rst) - reformat to 80 chars width - clarify checkpoints - remove workarounds for stuff that was fixed
2015-09-28document binary and non-binary requirementsThomas Waldmann
2015-09-26docs: explain --read-special in more detail, fixes #220Thomas Waldmann
2015-09-21docs: add how to build wheels and standalone binariesThomas Waldmann
2015-09-21docs: add a note about the single-file binariesThomas Waldmann
2015-09-19docs: must run make html after tagging, so the html titel says correct versionThomas Waldmann
2015-09-19docs: must run make html before release0.26.0Thomas Waldmann
2015-09-19add docs about release processThomas Waldmann
2015-09-19also mention libattrThomas Waldmann
ACLs are implemented as xattrs, so libattr is pulled in as a dependency of libacl.
2015-09-16be more precise about OpenBSD/NetBSD supportThomas Waldmann
xattrs/ACLs need platform specific code and new have none (yet) for them.
2015-09-16more platform support, works on py 3.5Thomas Waldmann
xattrs and ACLs on OpenBSD and NetBSD need development or adaptation of the platform-specific code.
2015-09-12detect lz4.h header file locationThomas Waldmann
use similar code as for openssl headers
2015-09-12llfuse 0.41 install troubles on some platforms, require < 0.41Thomas Waldmann
UnicodeDecodeError exception due to non-ascii llfuse setup.py
2015-09-12pkg-config is needed for llfuse installationThomas Waldmann
2015-09-06Merge pull request #183 from ThomasWaldmann/borg-repo-envvarTW
BORG_REPO env var support
2015-09-06BORG_REPO env var supportThomas Waldmann
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-06read special files as if they were regular files, update docs, closes #79Thomas Waldmann
do not use the files cache for such special files
2015-08-29remove docs/misc/create_compression.txtThomas Waldmann
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-29add FAQ entry about OS X commandline vs. HFS+ encoding issue, see #143.Thomas Waldmann
a real fix for this is in development, but needs some time.
2015-08-29docs: internals: improve structure and formattingThomas Waldmann
2015-08-29docs: improve faq and support sectionThomas Waldmann
2015-08-29docs: usage: improved formatting, cosmetic changesThomas Waldmann