Commit Graph

49 Commits

Author SHA1 Message Date
Thomas Waldmann 2a864be84f Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	setup.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-09-27 21:31:41 +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
Thomas Waldmann 2aa06533a3 fixup: typo in development.rst 2016-09-14 02:59:52 +02:00
Thomas Waldmann 1287d1ae92 Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	docs/development.rst
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/hashindex.pyx
#	src/borg/testsuite/hashindex.py
2016-09-14 02:53:41 +02:00
Thomas Waldmann b2e389e0a0 docs: add contribution guidelines 2016-09-08 19:40:32 +02:00
Thomas Waldmann c355f3617a Merge branch '1.0-maint' 2016-08-20 00:04:55 +02:00
Thomas Waldmann e3c155e75a use a clean repo to test / build the release 2016-08-15 15:41:24 +02:00
anarcat 661e8ebceb point to code, issues and support in devel section
real story: users that are also developpers expect to find out where
to submit issues and pull requests in the development section, but
couldn't. add some meat there and point to the support section for
everything else.
2016-08-03 11:37:46 -04:00
Marian Beermann ba23265559 docs, development: link to appveyor 2016-07-30 00:01:19 +02:00
Marian Beermann ac8c8119a7
Merge branch '1.0-maint' into master 2016-07-28 00:29:43 +02:00
Marian Beermann c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00
Marian Beermann 2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28:26 +02:00
Thomas Waldmann cf4d761042 docs: fix the highlighting
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Ed Blackman 226e5519f3 Print implied output without --info/-v
There are persistent questions why output from options like --list
and --stats doesn't show up.  Also, borg currently isn't able to
show *just* the output for a given option (--list, --stats,
--show-rc, --show-version, or --progress), without other INFO level
messages.

The solution is to use more granular loggers, so that messages
specific to a given option goes to a logger designated for that
option.  That option-specific logger can then be configured
separately from the regular loggers.

Those option-specific loggers can also be used as a hook in a
BORG_LOGGING_CONF config file to log the --list output to a separate
file, or send --stats output to a network socket where some daemon
could analyze it.

Steps:
- create an option-specific logger for each of the implied output options
- modify the messages specific to each option to go to the correct logger
- if an implied output option is passed, change the option-specific
  logger (only) to log at INFO level
- test that root logger messages don't come through option-specific loggers

They shouldn't, per https://docs.python.org/3/howto/logging.html#logging-flow
but test just the same.  Particularly test a message that can come from
remote repositories.

Fixes #526, #573, #665, #824
2016-05-18 14:58:44 -04:00
Thomas Waldmann 240e5696b7 fix vagrant ssh syntax, fixes #999 2016-05-01 20:18:17 +02:00
Thomas Waldmann 2170d6e502 fix order in release process docs
it is important to first do all the changes that modify the release contents,
then tag/sign it, then build the binaries via vagrant.

Only then the binaries will have the correct version number.
2016-02-07 14:44:49 +01:00
Thomas Waldmann 435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Thomas Waldmann a2843bc939 docs: require python 3.4+
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Thomas Waldmann 0f4d3b21c3 minor development docs fixes 2016-01-12 23:49:19 +01:00
Thomas Waldmann c200b79470 development docs: run build_api and build_usage before tagging release 2015-12-13 21:34:37 +01:00
Thomas Waldmann 74ee8154f2 add developer docs about output and logging 2015-12-08 01:45:22 +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 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
Antoine Beaupré 811c18dcd4 explain how to regenerate usage and API files and when 2015-11-13 10:46:13 -05:00
Thomas Waldmann 303bed9d12 docs: minor development docs update 2015-11-07 15:17:40 +01:00
Antoine Beaupré 03d381c2f9 describe the current style guide in documentation 2015-10-20 14:43:49 -04:00
Antoine Beaupré 500c2a8a20 fix warnings in docs generation 2015-10-19 11:09:28 -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
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 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 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
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 22f335e0a0 docs: add how to build wheels and standalone binaries 2015-09-21 21:48:46 +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 2402a2269e update docs about fakeroot 2015-08-20 23:39:40 +02:00
Thomas Waldmann d65ca51d54 deduplicate and refactor the docs
README.rst (shown on github and also at the start of the html docs) shall
be like an elevator speech - convince readers in a very short time.
this is most important, everything else can come after we got the reader's interest.

include README into docs to avoid duplication.
also include CHANGES into docs.
add developer docs, move examples from tox.ini there
add separate support docs
remove glossary, most of what was there can be understood by an admin from context
move attic and compatibility note to the end
2015-08-06 12:59:51 +02:00