changes.rst 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467
  1. Changelog
  2. =========
  3. Important note about pre-1.0.4 potential repo corruption
  4. --------------------------------------------------------
  5. Some external errors (like network or disk I/O errors) could lead to
  6. corruption of the backup repository due to issue #1138.
  7. A sign that this happened is if "E" status was reported for a file that can
  8. not be explained by problems with the source file. If you still have logs from
  9. "borg create -v --list", you can check for "E" status.
  10. Here is what could cause corruption and what you can do now:
  11. 1) I/O errors (e.g. repo disk errors) while writing data to repo.
  12. This could lead to corrupted segment files.
  13. Fix::
  14. # check for corrupt chunks / segments:
  15. borg check -v --repository-only REPO
  16. # repair the repo:
  17. borg check -v --repository-only --repair REPO
  18. # make sure everything is fixed:
  19. borg check -v --repository-only REPO
  20. 2) Unreliable network / unreliable connection to the repo.
  21. This could lead to archive metadata corruption.
  22. Fix::
  23. # check for corrupt archives:
  24. borg check -v --archives-only REPO
  25. # delete the corrupt archives:
  26. borg delete --force REPO::CORRUPT_ARCHIVE
  27. # make sure everything is fixed:
  28. borg check -v --archives-only REPO
  29. 3) In case you want to do more intensive checking.
  30. The best check that everything is ok is to run a dry-run extraction::
  31. borg extract -v --dry-run REPO::ARCHIVE
  32. Version 1.0.7 (not released yet)
  33. --------------------------------
  34. Security fixes:
  35. - fix security issue with remote repository access, #1428
  36. Bug fixes:
  37. - fixed repeated LockTimeout exceptions when borg serve tried to write into
  38. a already write-locked repo (e.g. by a borg mount), #502 part b)
  39. This was solved by the fix for #1220 in 1.0.7rc1 already.
  40. - fix cosmetics + file leftover for "not a valid borg repository", #1490
  41. - Cache: release lock if cache is invalid, #1501
  42. - borg extract --strip-components: fix leak of preloaded chunk contents
  43. - Repository, when a InvalidRepository exception happens:
  44. - fix spurious, empty lock.roster
  45. - fix repo not closed cleanly
  46. New features:
  47. - implement borg debug-info, fixes #1122
  48. (just calls already existing code via cli, same output as below tracebacks)
  49. Other changes:
  50. - skip the O_NOATIME test on GNU Hurd, fixes #1315
  51. (this is a very minor issue and the GNU Hurd project knows the bug)
  52. - document using a clean repo to test / build the release
  53. Version 1.0.7rc2 (2016-08-13)
  54. -----------------------------
  55. Bug fixes:
  56. - do not write objects to repository that are bigger than the allowed size,
  57. borg will reject reading them, #1451.
  58. Important: if you created archives with many millions of files or
  59. directories, please verify if you can open them successfully,
  60. e.g. try a "borg list REPO::ARCHIVE".
  61. - lz4 compression: dynamically enlarge the (de)compression buffer, the static
  62. buffer was not big enough for archives with extremely many items, #1453
  63. - larger item metadata stream chunks, raise archive item limit by 8x, #1452
  64. - fix untracked segments made by moved DELETEs, #1442
  65. Impact: Previously (metadata) segments could become untracked when deleting data,
  66. these would never be cleaned up.
  67. - extended attributes (xattrs) related fixes:
  68. - fixed a race condition in xattrs querying that led to the entire file not
  69. being backed up (while logging the error, exit code = 1), #1469
  70. - fixed a race condition in xattrs querying that led to a crash, #1462
  71. - raise OSError including the error message derived from errno, deal with
  72. path being a integer FD
  73. Other changes:
  74. - print active env var override by default, #1467
  75. - xattr module: refactor code, deduplicate, clean up
  76. - repository: split object size check into too small and too big
  77. - add a transaction_id assertion, so borg init on a broken (inconsistent)
  78. filesystem does not look like a coding error in borg, but points to the
  79. real problem.
  80. - explain confusing TypeError caused by compat support for old servers, #1456
  81. - add forgotten usage help file from build_usage
  82. - refactor/unify buffer code into helpers.Buffer class, add tests
  83. - docs:
  84. - document archive limitation, #1452
  85. - improve prune examples
  86. Version 1.0.7rc1 (2016-08-05)
  87. -----------------------------
  88. Bug fixes:
  89. - fix repo lock deadlocks (related to lock upgrade), #1220
  90. - catch unpacker exceptions, resync, #1351
  91. - fix borg break-lock ignoring BORG_REPO env var, #1324
  92. - files cache performance fixes (fixes unneccessary re-reading/chunking/
  93. hashing of unmodified files for some use cases):
  94. - fix unintended file cache eviction, #1430
  95. - implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10
  96. to 20, #1338
  97. - FUSE:
  98. - cache partially read data chunks (performance), #965, #966
  99. - always create a root dir, #1125
  100. - use an OrderedDict for helptext, making the build reproducible, #1346
  101. - RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
  102. - ignore stdout/stderr broken pipe errors (cosmetic), #1116
  103. New features:
  104. - better borg versions management support (useful esp. for borg servers
  105. wanting to offer multiple borg versions and for clients wanting to choose
  106. a specific server borg version), #1392:
  107. - add BORG_VERSION environment variable before executing "borg serve" via ssh
  108. - add new placeholder {borgversion}
  109. - substitute placeholders in --remote-path
  110. - borg init --append-only option (makes using the more secure append-only mode
  111. more convenient. when used remotely, this requires 1.0.7+ also on the borg
  112. server), #1291.
  113. Other changes:
  114. - Vagrantfile:
  115. - darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
  116. - xenial64: use user "ubuntu", not "vagrant" (as usual), #1331
  117. - tests:
  118. - fix fuse tests on OS X, #1433
  119. - docs:
  120. - FAQ: add backup using stable filesystem names recommendation
  121. - FAQ about glibc compatibility added, #491, glibc-check improved
  122. - FAQ: 'A' unchanged file; remove ambiguous entry age sentence.
  123. - OS X: install pkg-config to build with FUSE support, fixes #1400
  124. - add notes about shell/sudo pitfalls with env. vars, #1380
  125. - added platform feature matrix
  126. - implement borg debug-dump-repo-objs
  127. Version 1.0.6 (2016-07-12)
  128. --------------------------
  129. Bug fixes:
  130. - Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
  131. - Fix crash with unclear message if the libc is not found, #1314, #1111
  132. Other changes:
  133. - tests:
  134. - Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
  135. - Fixed sparse file tests for (file) systems not supporting it, #1310
  136. - docs:
  137. - Fixed syntax highlighting, #1313
  138. - misc docs: added data processing overview picture
  139. Version 1.0.6rc1 (2016-07-10)
  140. -----------------------------
  141. New features:
  142. - borg check --repair: heal damaged files if missing chunks re-appear (e.g. if
  143. the previously missing chunk was added again in a later backup archive),
  144. #148. (*) Also improved logging.
  145. Bug fixes:
  146. - sync_dir: silence fsync() failing with EINVAL, #1287
  147. Some network filesystems (like smbfs) don't support this and we use this in
  148. repository code.
  149. - borg mount (FUSE):
  150. - fix directories being shadowed when contained paths were also specified,
  151. #1295
  152. - raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is
  153. used), #1302. (*)
  154. - borg extract: warn if a damaged file is extracted, #1299. (*)
  155. - Added some missing return code checks (ChunkIndex._add, hashindex_resize).
  156. - borg check: fix/optimize initial hash table size, avoids resize of the table.
  157. Other changes:
  158. - tests:
  159. - add more FUSE tests, #1284
  160. - deduplicate fuse (u)mount code
  161. - fix borg binary test issues, #862
  162. - docs:
  163. - changelog: added release dates to older borg releases
  164. - fix some sphinx (docs generator) warnings, #881
  165. Notes:
  166. (*) Some features depend on information (chunks_healthy list) added to item
  167. metadata when a file with missing chunks was "repaired" using all-zero
  168. replacement chunks. The chunks_healthy list is generated since borg 1.0.4,
  169. thus borg can't recognize such "repaired" (but content-damaged) files if the
  170. repair was done with an older borg version.
  171. Version 1.0.5 (2016-07-07)
  172. --------------------------
  173. Bug fixes:
  174. - borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282
  175. Other changes:
  176. - backport some FAQ entries from master branch
  177. - add release helper scripts
  178. - Vagrantfile:
  179. - centos6: no FUSE, don't build binary
  180. - add xz for redhat-like dists
  181. Version 1.0.4 (2016-07-07)
  182. --------------------------
  183. New features:
  184. - borg serve --append-only, #1168
  185. This was included because it was a simple change (append-only functionality
  186. was already present via repository config file) and makes better security now
  187. practically usable.
  188. - BORG_REMOTE_PATH environment variable, #1258
  189. This was included because it was a simple change (--remote-path cli option
  190. was already present) and makes borg much easier to use if you need it.
  191. - Repository: cleanup incomplete transaction on "no space left" condition.
  192. In many cases, this can avoid a 100% full repo filesystem (which is very
  193. problematic as borg always needs free space - even to delete archives).
  194. Bug fixes:
  195. - Fix wrong handling and reporting of OSErrors in borg create, #1138.
  196. This was a serious issue: in the context of "borg create", errors like
  197. repository I/O errors (e.g. disk I/O errors, ssh repo connection errors)
  198. were handled badly and did not lead to a crash (which would be good for this
  199. case, because the repo transaction would be incomplete and trigger a
  200. transaction rollback to clean up).
  201. Now, error handling for source files is cleanly separated from every other
  202. error handling, so only problematic input files are logged and skipped.
  203. - Implement fail-safe error handling for borg extract.
  204. Note that this isn't nearly as critical as the borg create error handling
  205. bug, since nothing is written to the repo. So this was "merely" misleading
  206. error reporting.
  207. - Add missing error handler in directory attr restore loop.
  208. - repo: make sure write data hits disk before the commit tag (#1236) and also
  209. sync the containing directory.
  210. - FUSE: getxattr fail must use errno.ENOATTR, #1126
  211. (fixes Mac OS X Finder malfunction: "zero bytes" file length, access denied)
  212. - borg check --repair: do not lose information about the good/original chunks.
  213. If we do not lose the original chunk IDs list when "repairing" a file
  214. (replacing missing chunks with all-zero chunks), we have a chance to "heal"
  215. the file back into its original state later, in case the chunks re-appear
  216. (e.g. in a fresh backup). Healing is not implemented yet, see #148.
  217. - fixes for --read-special mode:
  218. - ignore known files cache, #1241
  219. - fake regular file mode, #1214
  220. - improve symlinks handling, #1215
  221. - remove passphrase from subprocess environment, #1105
  222. - Ignore empty index file (will trigger index rebuild), #1195
  223. - add missing placeholder support for --prefix, #1027
  224. - improve exception handling for placeholder replacement
  225. - catch and format exceptions in arg parsing
  226. - helpers: fix "undefined name 'e'" in exception handler
  227. - better error handling for missing repo manifest, #1043
  228. - borg delete:
  229. - make it possible to delete a repo without manifest
  230. - borg delete --forced allows to delete corrupted archives, #1139
  231. - borg check:
  232. - make borg check work for empty repo
  233. - fix resync and msgpacked item qualifier, #1135
  234. - rebuild_manifest: fix crash if 'name' or 'time' key were missing.
  235. - better validation of item metadata dicts, #1130
  236. - better validation of archive metadata dicts
  237. - close the repo on exit - even if rollback did not work, #1197.
  238. This is rather cosmetic, it avoids repo closing in the destructor.
  239. - tests:
  240. - fix sparse file test, #1170
  241. - flake8: ignore new F405, #1185
  242. - catch "invalid argument" on cygwin, #257
  243. - fix sparseness assertion in test prep, #1264
  244. Other changes:
  245. - make borg build/work on OpenSSL 1.0 and 1.1, #1187
  246. - docs / help:
  247. - fix / clarify prune help, #1143
  248. - fix "patterns" help formatting
  249. - add missing docs / help about placeholders
  250. - resources: rename atticmatic to borgmatic
  251. - document sshd settings, #545
  252. - more details about checkpoints, add split trick, #1171
  253. - support docs: add freenode web chat link, #1175
  254. - add prune visualization / example, #723
  255. - add note that Fnmatch is default, #1247
  256. - make clear that lzma levels > 6 are a waste of cpu cycles
  257. - add a "do not edit" note to auto-generated files, #1250
  258. - update cygwin installation docs
  259. - repository interoperability with borg master (1.1dev) branch:
  260. - borg check: read item metadata keys from manifest, #1147
  261. - read v2 hints files, #1235
  262. - fix hints file "unknown version" error handling bug
  263. - tests: add tests for format_line
  264. - llfuse: update version requirement for freebsd
  265. - Vagrantfile:
  266. - use openbsd 5.9, #716
  267. - do not install llfuse on netbsd (broken)
  268. - update OSXfuse to version 3.3.3
  269. - use Python 3.5.2 to build the binaries
  270. - glibc compatibility checker: scripts/glibc_check.py
  271. - add .eggs to .gitignore
  272. Version 1.0.3 (2016-05-20)
  273. --------------------------
  274. Bug fixes:
  275. - prune: avoid that checkpoints are kept and completed archives are deleted in
  276. a prune run), #997
  277. - prune: fix commandline argument validation - some valid command lines were
  278. considered invalid (annoying, but harmless), #942
  279. - fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
  280. - repository: fix commit tags being seen in data
  281. - when probing key files, do binary reads. avoids crash when non-borg binary
  282. files are located in borg's key files directory.
  283. - handle SIGTERM and make a clean exit - avoids orphan lock files.
  284. - repository cache: don't cache large objects (avoid using lots of temp. disk
  285. space), #1063
  286. Other changes:
  287. - Vagrantfile: OS X: update osxfuse / install lzma package, #933
  288. - setup.py: add check for platform_darwin.c
  289. - setup.py: on freebsd, use a llfuse release that builds ok
  290. - docs / help:
  291. - update readthedocs URLs, #991
  292. - add missing docs for "borg break-lock", #992
  293. - borg create help: add some words to about the archive name
  294. - borg create help: document format tags, #894
  295. Version 1.0.2 (2016-04-16)
  296. --------------------------
  297. Bug fixes:
  298. - fix malfunction and potential corruption on (nowadays rather rare) big-endian
  299. architectures or bi-endian archs in (rare) BE mode. #886, #889
  300. cache resync / index merge was malfunctioning due to this, potentially
  301. leading to data loss. borg info had cosmetic issues (displayed wrong values).
  302. note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs
  303. in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.
  304. - add overflow and range checks for 1st (special) uint32 of the hashindex
  305. values, switch from int32 to uint32.
  306. - fix so that refcount will never overflow, but just stick to max. value after
  307. a overflow would have occured.
  308. - borg delete: fix --cache-only for broken caches, #874
  309. Makes --cache-only idempotent: it won't fail if the cache is already deleted.
  310. - fixed borg create --one-file-system erroneously traversing into other
  311. filesystems (if starting fs device number was 0), #873
  312. - workround a bug in Linux fadvise FADV_DONTNEED, #907
  313. Other changes:
  314. - better test coverage for hashindex, incl. overflow testing, checking correct
  315. computations so endianness issues would be discovered.
  316. - reproducible doc for ProgressIndicator*, make the build reproducible.
  317. - use latest llfuse for vagrant machines
  318. - docs:
  319. - use /path/to/repo in examples, fixes #901
  320. - fix confusing usage of "repo" as archive name (use "arch")
  321. Version 1.0.1 (2016-04-08)
  322. --------------------------
  323. New features:
  324. Usually there are no new features in a bugfix release, but these were added
  325. due to their high impact on security/safety/speed or because they are fixes
  326. also:
  327. - append-only mode for repositories, #809, #36 (see docs)
  328. - borg create: add --ignore-inode option to make borg detect unmodified files
  329. even if your filesystem does not have stable inode numbers (like sshfs and
  330. possibly CIFS).
  331. - add options --warning, --error, --critical for missing log levels, #826.
  332. it's not recommended to suppress warnings or errors, but the user may decide
  333. this on his own.
  334. note: --warning is not given to borg serve so a <= 1.0.0 borg will still
  335. work as server (it is not needed as it is the default).
  336. do not use --error or --critical when using a <= 1.0.0 borg server.
  337. Bug fixes:
  338. - fix silently skipping EIO, #748
  339. - add context manager for Repository (avoid orphan repository locks), #285
  340. - do not sleep for >60s while waiting for lock, #773
  341. - unpack file stats before passing to FUSE
  342. - fix build on illumos
  343. - don't try to backup doors or event ports (Solaris and derivates)
  344. - remove useless/misleading libc version display, #738
  345. - test suite: reset exit code of persistent archiver, #844
  346. - RemoteRepository: clean up pipe if remote open() fails
  347. - Remote: don't print tracebacks for Error exceptions handled downstream, #792
  348. - if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
  349. instead, #791
  350. - ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
  351. - fix capitalization, add ellipses, change log level to debug for 2 messages,
  352. #798
  353. Other changes:
  354. - update llfuse requirement, llfuse 1.0 works
  355. - update OS / dist packages on build machines, #717
  356. - prefer showing --info over -v in usage help, #859
  357. - docs:
  358. - fix cygwin requirements (gcc-g++)
  359. - document how to debug / file filesystem issues, #664
  360. - fix reproducible build of api docs
  361. - RTD theme: CSS !important overwrite, #727
  362. - Document logo font. Recreate logo png. Remove GIMP logo file.
  363. Version 1.0.0 (2016-03-05)
  364. --------------------------
  365. The major release number change (0.x -> 1.x) indicates bigger incompatible
  366. changes, please read the compatibility notes, adapt / test your scripts and
  367. check your backup logs.
  368. Compatibility notes:
  369. - drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490
  370. note: we provide binaries that include python 3.5.1 and everything else
  371. needed. they are an option in case you are stuck with < 3.4 otherwise.
  372. - change encryption to be on by default (using "repokey" mode)
  373. - moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys,
  374. you can either move them manually or run "borg upgrade <REPO>"
  375. - remove support for --encryption=passphrase,
  376. use borg migrate-to-repokey to switch to repokey mode, #97
  377. - remove deprecated --compression <number>,
  378. use --compression zlib,<number> instead
  379. in case of 0, you could also use --compression none
  380. - remove deprecated --hourly/daily/weekly/monthly/yearly
  381. use --keep-hourly/daily/weekly/monthly/yearly instead
  382. - remove deprecated --do-not-cross-mountpoints,
  383. use --one-file-system instead
  384. - disambiguate -p option, #563:
  385. - -p now is same as --progress
  386. - -P now is same as --prefix
  387. - remove deprecated "borg verify",
  388. use "borg extract --dry-run" instead
  389. - cleanup environment variable semantics, #355
  390. the environment variables used to be "yes sayers" when set, this was
  391. conceptually generalized to "automatic answerers" and they just give their
  392. value as answer (as if you typed in that value when being asked).
  393. See the "usage" / "Environment Variables" section of the docs for details.
  394. - change the builtin default for --chunker-params, create 2MiB chunks, #343
  395. --chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095
  396. one of the biggest issues with borg < 1.0 (and also attic) was that it had a
  397. default target chunk size of 64kiB, thus it created a lot of chunks and thus
  398. also a huge chunk management overhead (high RAM and disk usage).
  399. please note that the new default won't change the chunks that you already
  400. have in your repository. the new big chunks do not deduplicate with the old
  401. small chunks, so expect your repo to grow at least by the size of every
  402. changed file and in the worst case (e.g. if your files cache was lost / is
  403. not used) by the size of every file (minus any compression you might use).
  404. in case you want to immediately see a much lower resource usage (RAM / disk)
  405. for chunks management, it might be better to start with a new repo than
  406. continuing in the existing repo (with an existing repo, you'ld have to wait
  407. until all archives with small chunks got pruned to see a lower resource
  408. usage).
  409. if you used the old --chunker-params default value (or if you did not use
  410. --chunker-params option at all) and you'ld like to continue using small
  411. chunks (and you accept the huge resource usage that comes with that), just
  412. explicitly use borg create --chunker-params=10,23,16,4095.
  413. - archive timestamps: the 'time' timestamp now refers to archive creation
  414. start time (was: end time), the new 'time_end' timestamp refers to archive
  415. creation end time. This might affect prune if your backups take rather long.
  416. if you give a timestamp via cli this is stored into 'time', therefore it now
  417. needs to mean archive creation start time.
  418. New features:
  419. - implement password roundtrip, #695
  420. Bug fixes:
  421. - remote end does not need cache nor keys directories, do not create them, #701
  422. - added retry counter for passwords, #703
  423. Other changes:
  424. - fix compiler warnings, #697
  425. - docs:
  426. - update README.rst to new changelog location in docs/changes.rst
  427. - add Teemu to AUTHORS
  428. - changes.rst: fix old chunker params, #698
  429. - FAQ: how to limit bandwidth
  430. Version 1.0.0rc2 (2016-02-28)
  431. -----------------------------
  432. New features:
  433. - format options for location: user, pid, fqdn, hostname, now, utcnow, user
  434. - borg list --list-format
  435. - borg prune -v --list enables the keep/prune list output, #658
  436. Bug fixes:
  437. - fix _open_rb noatime handling, #657
  438. - add a simple archivename validator, #680
  439. - borg create --stats: show timestamps in localtime, use same labels/formatting
  440. as borg info, #651
  441. - llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)
  442. Other changes:
  443. - it is now possible to use "pip install borgbackup[fuse]" to automatically
  444. install the llfuse dependency using the correct version requirement
  445. for it. you still need to care about having installed the FUSE / build
  446. related OS package first, though, so that building llfuse can succeed.
  447. - Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
  448. - Vagrant: use pyinstaller v3.1.1 to build binaries
  449. - docs:
  450. - borg upgrade: add to docs that only LOCAL repos are supported
  451. - borg upgrade also handles borg 0.xx -> 1.0
  452. - use pip extras or requirements file to install llfuse
  453. - fix order in release process
  454. - updated usage docs and other minor / cosmetic fixes
  455. - verified borg examples in docs, #644
  456. - freebsd dependency installation and fuse configuration, #649
  457. - add example how to restore a raw device, #671
  458. - add a hint about the dev headers needed when installing from source
  459. - add examples for delete (and handle delete after list, before prune), #656
  460. - update example for borg create -v --stats (use iso datetime format), #663
  461. - added example to BORG_RSH docs
  462. - "connection closed by remote": add FAQ entry and point to issue #636
  463. Version 1.0.0rc1 (2016-02-07)
  464. -----------------------------
  465. New features:
  466. - borg migrate-to-repokey ("passphrase" -> "repokey" encryption key mode)
  467. - implement --short for borg list REPO, #611
  468. - implement --list for borg extract (consistency with borg create)
  469. - borg serve: overwrite client's --restrict-to-path with ssh forced command's
  470. option value (but keep everything else from the client commandline), #544
  471. - use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
  472. - "borg upgrade" moves the keyfile keys to the new location
  473. - display both archive creation start and end time in "borg info", #627
  474. Bug fixes:
  475. - normalize trailing slashes for the repository path, #606
  476. - Cache: fix exception handling in __init__, release lock, #610
  477. Other changes:
  478. - suppress unneeded exception context (PEP 409), simpler tracebacks
  479. - removed special code needed to deal with imperfections / incompatibilities /
  480. missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
  481. - removed some version requirements that were kept on old versions because
  482. newer did not support py 3.2 any more
  483. - use some py 3.4+ stdlib code instead of own/openssl/pypi code:
  484. - use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
  485. - use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
  486. - use hmac.compare_digest instead of == operator (constant time comparison)
  487. - use stat.filemode instead of homegrown code
  488. - use "mock" library from stdlib, #145
  489. - remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
  490. - Vagrant: copy CHANGES.rst as symlink, #592
  491. - cosmetic code cleanups, add flake8 to tox/travis, #4
  492. - docs / help:
  493. - make "borg -h" output prettier, #591
  494. - slightly rephrase prune help
  495. - add missing example for --list option of borg create
  496. - quote exclude line that includes an asterisk to prevent shell expansion
  497. - fix dead link to license
  498. - delete Ubuntu Vivid, it is not supported anymore (EOL)
  499. - OS X binary does not work for older OS X releases, #629
  500. - borg serve's special support for forced/original ssh commands, #544
  501. - misc. updates and fixes
  502. Version 0.30.0 (2016-01-23)
  503. ---------------------------
  504. Compatibility notes:
  505. - you may need to use -v (or --info) more often to actually see output emitted
  506. at INFO log level (because it is suppressed at the default WARNING log level).
  507. See the "general" section in the usage docs.
  508. - for borg create, you need --list (additionally to -v) to see the long file
  509. list (was needed so you can have e.g. --stats alone without the long list)
  510. - see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was:
  511. BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)
  512. Bug fixes:
  513. - fix crash when using borg create --dry-run --keep-tag-files, #570
  514. - make sure teardown with cleanup happens for Cache and RepositoryCache,
  515. avoiding leftover locks and TEMP dir contents, #285 (partially), #548
  516. - fix locking KeyError, partial fix for #502
  517. - log stats consistently, #526
  518. - add abbreviated weekday to timestamp format, fixes #496
  519. - strip whitespace when loading exclusions from file
  520. - unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library
  521. version warning when using the borg binary, #514
  522. - add some error handling/fallback for C library loading, #494
  523. - added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in "borg delete", #503
  524. - remove unused "repair" rpc method name
  525. New features:
  526. - borg create: implement exclusions using regular expression patterns.
  527. - borg create: implement inclusions using patterns.
  528. - borg extract: support patterns, #361
  529. - support different styles for patterns:
  530. - fnmatch (`fm:` prefix, default when omitted), like borg <= 0.29.
  531. - shell (`sh:` prefix) with `*` not matching directory separators and
  532. `**/` matching 0..n directories
  533. - path prefix (`pp:` prefix, for unifying borg create pp1 pp2 into the
  534. patterns system), semantics like in borg <= 0.29
  535. - regular expression (`re:`), new!
  536. - --progress option for borg upgrade (#291) and borg delete <archive>
  537. - update progress indication more often (e.g. for borg create within big
  538. files or for borg check repo), #500
  539. - finer chunker granularity for items metadata stream, #547, #487
  540. - borg create --list now used (additionally to -v) to enable the verbose
  541. file list output
  542. - display borg version below tracebacks, #532
  543. Other changes:
  544. - hashtable size (and thus: RAM and disk consumption) follows a growth policy:
  545. grows fast while small, grows slower when getting bigger, #527
  546. - Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix,
  547. fixes #569
  548. - no separate binaries for centos6 any more because the generic linux binaries
  549. also work on centos6 (or in general: on systems with a slightly older glibc
  550. than debian7
  551. - dev environment: require virtualenv<14.0 so we get a py32 compatible pip
  552. - docs:
  553. - add space-saving chunks.archive.d trick to FAQ
  554. - important: clarify -v and log levels in usage -> general, please read!
  555. - sphinx configuration: create a simple man page from usage docs
  556. - add a repo server setup example
  557. - disable unneeded SSH features in authorized_keys examples for security.
  558. - borg prune only knows "--keep-within" and not "--within"
  559. - add gource video to resources docs, #507
  560. - add netbsd install instructions
  561. - authors: make it more clear what refers to borg and what to attic
  562. - document standalone binary requirements, #499
  563. - rephrase the mailing list section
  564. - development docs: run build_api and build_usage before tagging release
  565. - internals docs: hash table max. load factor is 0.75 now
  566. - markup, typo, grammar, phrasing, clarifications and other fixes.
  567. - add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583
  568. Version 0.29.0 (2015-12-13)
  569. ---------------------------
  570. Compatibility notes:
  571. - when upgrading to 0.29.0 you need to upgrade client as well as server
  572. installations due to the locking and commandline interface changes otherwise
  573. you'll get an error msg about a RPC protocol mismatch or a wrong commandline
  574. option.
  575. if you run a server that needs to support both old and new clients, it is
  576. suggested that you have a "borg-0.28.2" and a "borg-0.29.0" command.
  577. clients then can choose via e.g. "borg --remote-path=borg-0.29.0 ...".
  578. - the default waiting time for a lock changed from infinity to 1 second for a
  579. better interactive user experience. if the repo you want to access is
  580. currently locked, borg will now terminate after 1s with an error message.
  581. if you have scripts that shall wait for the lock for a longer time, use
  582. --lock-wait N (with N being the maximum wait time in seconds).
  583. Bug fixes:
  584. - hash table tuning (better chosen hashtable load factor 0.75 and prime initial
  585. size of 1031 gave ~1000x speedup in some scenarios)
  586. - avoid creation of an orphan lock for one case, #285
  587. - --keep-tag-files: fix file mode and multiple tag files in one directory, #432
  588. - fixes for "borg upgrade" (attic repo converter), #466
  589. - remove --progress isatty magic (and also --no-progress option) again, #476
  590. - borg init: display proper repo URL
  591. - fix format of umask in help pages, #463
  592. New features:
  593. - implement --lock-wait, support timeout for UpgradableLock, #210
  594. - implement borg break-lock command, #157
  595. - include system info below traceback, #324
  596. - sane remote logging, remote stderr, #461:
  597. - remote log output: intercept it and log it via local logging system,
  598. with "Remote: " prefixed to message. log remote tracebacks.
  599. - remote stderr: output it to local stderr with "Remote: " prefixed.
  600. - add --debug and --info (same as --verbose) to set the log level of the
  601. builtin logging configuration (which otherwise defaults to warning), #426
  602. note: there are few messages emitted at DEBUG level currently.
  603. - optionally configure logging via env var BORG_LOGGING_CONF
  604. - add --filter option for status characters: e.g. to show only the added
  605. or modified files (and also errors), use "borg create -v --filter=AME ...".
  606. - more progress indicators, #394
  607. - use ISO-8601 date and time format, #375
  608. - "borg check --prefix" to restrict archive checking to that name prefix, #206
  609. Other changes:
  610. - hashindex_add C implementation (speed up cache re-sync for new archives)
  611. - increase FUSE read_size to 1024 (speed up metadata operations)
  612. - check/delete/prune --save-space: free unused segments quickly, #239
  613. - increase rpc protocol version to 2 (see also Compatibility notes), #458
  614. - silence borg by default (via default log level WARNING)
  615. - get rid of C compiler warnings, #391
  616. - upgrade OS X FUSE to 3.0.9 on the OS X binary build system
  617. - use python 3.5.1 to build binaries
  618. - docs:
  619. - new mailing list borgbackup@python.org, #468
  620. - readthedocs: color and logo improvements
  621. - load coverage icons over SSL (avoids mixed content)
  622. - more precise binary installation steps
  623. - update release procedure docs about OS X FUSE
  624. - FAQ entry about unexpected 'A' status for unchanged file(s), #403
  625. - add docs about 'E' file status
  626. - add "borg upgrade" docs, #464
  627. - add developer docs about output and logging
  628. - clarify encryption, add note about client-side encryption
  629. - add resources section, with videos, talks, presentations, #149
  630. - Borg moved to Arch Linux [community]
  631. - fix wrong installation instructions for archlinux
  632. Version 0.28.2 (2015-11-15)
  633. ---------------------------
  634. New features:
  635. - borg create --exclude-if-present TAGFILE - exclude directories that have the
  636. given file from the backup. You can additionally give --keep-tag-files to
  637. preserve just the directory roots and the tag-files (but not backup other
  638. directory contents), #395, attic #128, attic #142
  639. Other changes:
  640. - do not create docs sources at build time (just have them in the repo),
  641. completely remove have_cython() hack, do not use the "mock" library at build
  642. time, #384
  643. - avoid hidden import, make it easier for PyInstaller, easier fix for #218
  644. - docs:
  645. - add description of item flags / status output, fixes #402
  646. - explain how to regenerate usage and API files (build_api or
  647. build_usage) and when to commit usage files directly into git, #384
  648. - minor install docs improvements
  649. Version 0.28.1 (2015-11-08)
  650. ---------------------------
  651. Bug fixes:
  652. - do not try to build api / usage docs for production install,
  653. fixes unexpected "mock" build dependency, #384
  654. Other changes:
  655. - avoid using msgpack.packb at import time
  656. - fix formatting issue in changes.rst
  657. - fix build on readthedocs
  658. Version 0.28.0 (2015-11-08)
  659. ---------------------------
  660. Compatibility notes:
  661. - changed return codes (exit codes), see docs. in short:
  662. old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error
  663. New features:
  664. - refactor return codes (exit codes), fixes #61
  665. - add --show-rc option enable "terminating with X status, rc N" output, fixes 58, #351
  666. - borg create backups atime and ctime additionally to mtime, fixes #317
  667. - extract: support atime additionally to mtime
  668. - FUSE: support ctime and atime additionally to mtime
  669. - support borg --version
  670. - emit a warning if we have a slow msgpack installed
  671. - borg list --prefix=thishostname- REPO, fixes #205
  672. - Debug commands (do not use except if you know what you do: debug-get-obj,
  673. debug-put-obj, debug-delete-obj, debug-dump-archive-items.
  674. Bug fixes:
  675. - setup.py: fix bug related to BORG_LZ4_PREFIX processing
  676. - fix "check" for repos that have incomplete chunks, fixes #364
  677. - borg mount: fix unlocking of repository at umount time, fixes #331
  678. - fix reading files without touching their atime, #334
  679. - non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
  680. - fix acl_use_local_uid_gid() and add a test for it, attic #359
  681. - borg upgrade: do not upgrade repositories in place by default, #299
  682. - fix cascading failure with the index conversion code, #269
  683. - borg check: implement 'cmdline' archive metadata value decoding, #311
  684. - fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys
  685. were missing, but also bsdflags). add check for unknown metadata keys.
  686. - create from stdin: also save atime, ctime (cosmetic)
  687. - use default_notty=False for confirmations, fixes #345
  688. - vagrant: fix msgpack installation on centos, fixes #342
  689. - deal with unicode errors for symlinks in same way as for regular files and
  690. have a helpful warning message about how to fix wrong locale setup, fixes #382
  691. - add ACL keys the RobustUnpacker must know about
  692. Other changes:
  693. - improve file size displays, more flexible size formatters
  694. - explicitly commit to the units standard, #289
  695. - archiver: add E status (means that an error occurred when processing this
  696. (single) item
  697. - do binary releases via "github releases", closes #214
  698. - create: use -x and --one-file-system (was: --do-not-cross-mountpoints), #296
  699. - a lot of changes related to using "logging" module and screen output, #233
  700. - show progress display if on a tty, output more progress information, #303
  701. - factor out status output so it is consistent, fix surrogates removal,
  702. maybe fixes #309
  703. - move away from RawConfigParser to ConfigParser
  704. - archive checker: better error logging, give chunk_id and sequence numbers
  705. (can be used together with borg debug-dump-archive-items).
  706. - do not mention the deprecated passphrase mode
  707. - emit a deprecation warning for --compression N (giving a just a number)
  708. - misc .coverragerc fixes (and coverage measurement improvements), fixes #319
  709. - refactor confirmation code, reduce code duplication, add tests
  710. - prettier error messages, fixes #307, #57
  711. - tests:
  712. - add a test to find disk-full issues, #327
  713. - travis: also run tests on Python 3.5
  714. - travis: use tox -r so it rebuilds the tox environments
  715. - test the generated pyinstaller-based binary by archiver unit tests, #215
  716. - vagrant: tests: announce whether fakeroot is used or not
  717. - vagrant: add vagrant user to fuse group for debianoid systems also
  718. - vagrant: llfuse install on darwin needs pkgconfig installed
  719. - vagrant: use pyinstaller from develop branch, fixes #336
  720. - benchmarks: test create, extract, list, delete, info, check, help, fixes #146
  721. - benchmarks: test with both the binary and the python code
  722. - archiver tests: test with both the binary and the python code, fixes #215
  723. - make basic test more robust
  724. - docs:
  725. - moved docs to borgbackup.readthedocs.org, #155
  726. - a lot of fixes and improvements, use mobile-friendly RTD standard theme
  727. - use zlib,6 compression in some examples, fixes #275
  728. - add missing rename usage to docs, closes #279
  729. - include the help offered by borg help <topic> in the usage docs, fixes #293
  730. - include a list of major changes compared to attic into README, fixes #224
  731. - add OS X install instructions, #197
  732. - more details about the release process, #260
  733. - fix linux glibc requirement (binaries built on debian7 now)
  734. - build: move usage and API generation to setup.py
  735. - update docs about return codes, #61
  736. - remove api docs (too much breakage on rtd)
  737. - borgbackup install + basics presentation (asciinema)
  738. - describe the current style guide in documentation
  739. - add section about debug commands
  740. - warn about not running out of space
  741. - add example for rename
  742. - improve chunker params docs, fixes #362
  743. - minor development docs update
  744. Version 0.27.0 (2015-10-07)
  745. ---------------------------
  746. New features:
  747. - "borg upgrade" command - attic -> borg one time converter / migration, #21
  748. - temporary hack to avoid using lots of disk space for chunks.archive.d, #235:
  749. To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
  750. - respect XDG_CACHE_HOME, attic #181
  751. - add support for arbitrary SSH commands, attic #99
  752. - borg delete --cache-only REPO (only delete cache, not REPO), attic #123
  753. Bug fixes:
  754. - use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow
  755. down observed when running the Centos6-built binary on Ubuntu, #222
  756. - do not crash on empty lock.roster, fixes #232
  757. - fix multiple issues with the cache config version check, #234
  758. - fix segment entry header size check, attic #352
  759. plus other error handling improvements / code deduplication there.
  760. - always give segment and offset in repo IntegrityErrors
  761. Other changes:
  762. - stop producing binary wheels, remove docs about it, #147
  763. - docs:
  764. - add warning about prune
  765. - generate usage include files only as needed
  766. - development docs: add Vagrant section
  767. - update / improve / reformat FAQ
  768. - hint to single-file pyinstaller binaries from README
  769. Version 0.26.1 (2015-09-28)
  770. ---------------------------
  771. This is a minor update, just docs and new pyinstaller binaries.
  772. - docs update about python and binary requirements
  773. - better docs for --read-special, fix #220
  774. - re-built the binaries, fix #218 and #213 (glibc version issue)
  775. - update web site about single-file pyinstaller binaries
  776. Note: if you did a python-based installation, there is no need to upgrade.
  777. Version 0.26.0 (2015-09-19)
  778. ---------------------------
  779. New features:
  780. - Faster cache sync (do all in one pass, remove tar/compression stuff), #163
  781. - BORG_REPO env var to specify the default repo, #168
  782. - read special files as if they were regular files, #79
  783. - implement borg create --dry-run, attic issue #267
  784. - Normalize paths before pattern matching on OS X, #143
  785. - support OpenBSD and NetBSD (except xattrs/ACLs)
  786. - support / run tests on Python 3.5
  787. Bug fixes:
  788. - borg mount repo: use absolute path, attic #200, attic #137
  789. - chunker: use off_t to get 64bit on 32bit platform, #178
  790. - initialize chunker fd to -1, so it's not equal to STDIN_FILENO (0)
  791. - fix reaction to "no" answer at delete repo prompt, #182
  792. - setup.py: detect lz4.h header file location
  793. - to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
  794. - fix for obtaining ``char *`` from temporary Python value (old code causes
  795. a compile error on Mint 17.2)
  796. - llfuse 0.41 install troubles on some platforms, require < 0.41
  797. (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
  798. - cython code: add some int types to get rid of unspecific python add /
  799. subtract operations (avoid ``undefined symbol FPE_``... error on some platforms)
  800. - fix verbose mode display of stdin backup
  801. - extract: warn if a include pattern never matched, fixes #209,
  802. implement counters for Include/ExcludePatterns
  803. - archive names with slashes are invalid, attic issue #180
  804. - chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined -
  805. fixes building on OpenBSD.
  806. Other changes:
  807. - detect inconsistency / corruption / hash collision, #170
  808. - replace versioneer with setuptools_scm, #106
  809. - docs:
  810. - pkg-config is needed for llfuse installation
  811. - be more clear about pruning, attic issue #132
  812. - unit tests:
  813. - xattr: ignore security.selinux attribute showing up
  814. - ext3 seems to need a bit more space for a sparse file
  815. - do not test lzma level 9 compression (avoid MemoryError)
  816. - work around strange mtime granularity issue on netbsd, fixes #204
  817. - ignore st_rdev if file is not a block/char device, fixes #203
  818. - stay away from the setgid and sticky mode bits
  819. - use Vagrant to do easy cross-platform testing (#196), currently:
  820. - Debian 7 "wheezy" 32bit, Debian 8 "jessie" 64bit
  821. - Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
  822. - Centos 7 64bit
  823. - FreeBSD 10.2 64bit
  824. - OpenBSD 5.7 64bit
  825. - NetBSD 6.1.5 64bit
  826. - Darwin (OS X Yosemite)
  827. Version 0.25.0 (2015-08-29)
  828. ---------------------------
  829. Compatibility notes:
  830. - lz4 compression library (liblz4) is a new requirement (#156)
  831. - the new compression code is very compatible: as long as you stay with zlib
  832. compression, older borg releases will still be able to read data from a
  833. repo/archive made with the new code (note: this is not the case for the
  834. default "none" compression, use "zlib,0" if you want a "no compression" mode
  835. that can be read by older borg). Also the new code is able to read repos and
  836. archives made with older borg versions (for all zlib levels 0..9).
  837. Deprecations:
  838. - --compression N (with N being a number, as in 0.24) is deprecated.
  839. We keep the --compression 0..9 for now to not break scripts, but it is
  840. deprecated and will be removed later, so better fix your scripts now:
  841. --compression 0 (as in 0.24) is the same as --compression zlib,0 (now).
  842. BUT: if you do not want compression, you rather want --compression none
  843. (which is the default).
  844. --compression 1 (in 0.24) is the same as --compression zlib,1 (now)
  845. --compression 9 (in 0.24) is the same as --compression zlib,9 (now)
  846. New features:
  847. - create --compression none (default, means: do not compress, just pass through
  848. data "as is". this is more efficient than zlib level 0 as used in borg 0.24)
  849. - create --compression lz4 (super-fast, but not very high compression)
  850. - create --compression zlib,N (slower, higher compression, default for N is 6)
  851. - create --compression lzma,N (slowest, highest compression, default N is 6)
  852. - honor the nodump flag (UF_NODUMP) and do not backup such items
  853. - list --short just outputs a simple list of the files/directories in an archive
  854. Bug fixes:
  855. - fixed --chunker-params parameter order confusion / malfunction, fixes #154
  856. - close fds of segments we delete (during compaction)
  857. - close files which fell out the lrucache
  858. - fadvise DONTNEED now is only called for the byte range actually read, not for
  859. the whole file, fixes #158.
  860. - fix issue with negative "all archives" size, fixes #165
  861. - restore_xattrs: ignore if setxattr fails with EACCES, fixes #162
  862. Other changes:
  863. - remove fakeroot requirement for tests, tests run faster without fakeroot
  864. (test setup does not fail any more without fakeroot, so you can run with or
  865. without fakeroot), fixes #151 and #91.
  866. - more tests for archiver
  867. - recover_segment(): don't assume we have an fd for segment
  868. - lrucache refactoring / cleanup, add dispose function, py.test tests
  869. - generalize hashindex code for any key length (less hardcoding)
  870. - lock roster: catch file not found in remove() method and ignore it
  871. - travis CI: use requirements file
  872. - improved docs:
  873. - replace hack for llfuse with proper solution (install libfuse-dev)
  874. - update docs about compression
  875. - update development docs about fakeroot
  876. - internals: add some words about lock files / locking system
  877. - support: mention BountySource and for what it can be used
  878. - theme: use a lighter green
  879. - add pypi, wheel, dist package based install docs
  880. - split install docs into system-specific preparations and generic instructions
  881. Version 0.24.0 (2015-08-09)
  882. ---------------------------
  883. Incompatible changes (compared to 0.23):
  884. - borg now always issues --umask NNN option when invoking another borg via ssh
  885. on the repository server. By that, it's making sure it uses the same umask
  886. for remote repos as for local ones. Because of this, you must upgrade both
  887. server and client(s) to 0.24.
  888. - the default umask is 077 now (if you do not specify via --umask) which might
  889. be a different one as you used previously. The default umask avoids that
  890. you accidentally give access permissions for group and/or others to files
  891. created by borg (e.g. the repository).
  892. Deprecations:
  893. - "--encryption passphrase" mode is deprecated, see #85 and #97.
  894. See the new "--encryption repokey" mode for a replacement.
  895. New features:
  896. - borg create --chunker-params ... to configure the chunker, fixes #16
  897. (attic #302, attic #300, and somehow also #41).
  898. This can be used to reduce memory usage caused by chunk management overhead,
  899. so borg does not create a huge chunks index/repo index and eats all your RAM
  900. if you back up lots of data in huge files (like VM disk images).
  901. See docs/misc/create_chunker-params.txt for more information.
  902. - borg info now reports chunk counts in the chunk index.
  903. - borg create --compression 0..9 to select zlib compression level, fixes #66
  904. (attic #295).
  905. - borg init --encryption repokey (to store the encryption key into the repo),
  906. fixes #85
  907. - improve at-end error logging, always log exceptions and set exit_code=1
  908. - LoggedIO: better error checks / exceptions / exception handling
  909. - implement --remote-path to allow non-default-path borg locations, #125
  910. - implement --umask M and use 077 as default umask for better security, #117
  911. - borg check: give a named single archive to it, fixes #139
  912. - cache sync: show progress indication
  913. - cache sync: reimplement the chunk index merging in C
  914. Bug fixes:
  915. - fix segfault that happened for unreadable files (chunker: n needs to be a
  916. signed size_t), #116
  917. - fix the repair mode, #144
  918. - repo delete: add destroy to allowed rpc methods, fixes issue #114
  919. - more compatible repository locking code (based on mkdir), maybe fixes #92
  920. (attic #317, attic #201).
  921. - better Exception msg if no Borg is installed on the remote repo server, #56
  922. - create a RepositoryCache implementation that can cope with >2GiB,
  923. fixes attic #326.
  924. - fix Traceback when running check --repair, attic #232
  925. - clarify help text, fixes #73.
  926. - add help string for --no-files-cache, fixes #140
  927. Other changes:
  928. - improved docs:
  929. - added docs/misc directory for misc. writeups that won't be included
  930. "as is" into the html docs.
  931. - document environment variables and return codes (attic #324, attic #52)
  932. - web site: add related projects, fix web site url, IRC #borgbackup
  933. - Fedora/Fedora-based install instructions added to docs
  934. - Cygwin-based install instructions added to docs
  935. - updated AUTHORS
  936. - add FAQ entries about redundancy / integrity
  937. - clarify that borg extract uses the cwd as extraction target
  938. - update internals doc about chunker params, memory usage and compression
  939. - added docs about development
  940. - add some words about resource usage in general
  941. - document how to backup a raw disk
  942. - add note about how to run borg from virtual env
  943. - add solutions for (ll)fuse installation problems
  944. - document what borg check does, fixes #138
  945. - reorganize borgbackup.github.io sidebar, prev/next at top
  946. - deduplicate and refactor the docs / README.rst
  947. - use borg-tmp as prefix for temporary files / directories
  948. - short prune options without "keep-" are deprecated, do not suggest them
  949. - improved tox configuration
  950. - remove usage of unittest.mock, always use mock from pypi
  951. - use entrypoints instead of scripts, for better use of the wheel format and
  952. modern installs
  953. - add requirements.d/development.txt and modify tox.ini
  954. - use travis-ci for testing based on Linux and (new) OS X
  955. - use coverage.py, pytest-cov and codecov.io for test coverage support
  956. I forgot to list some stuff already implemented in 0.23.0, here they are:
  957. New features:
  958. - efficient archive list from manifest, meaning a big speedup for slow
  959. repo connections and "list <repo>", "delete <repo>", "prune" (attic #242,
  960. attic #167)
  961. - big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
  962. - hashindex: improve error messages
  963. Other changes:
  964. - explicitly specify binary mode to open binary files
  965. - some easy micro optimizations
  966. Version 0.23.0 (2015-06-11)
  967. ---------------------------
  968. Incompatible changes (compared to attic, fork related):
  969. - changed sw name and cli command to "borg", updated docs
  970. - package name (and name in urls) uses "borgbackup" to have less collisions
  971. - changed repo / cache internal magic strings from ATTIC* to BORG*,
  972. changed cache location to .cache/borg/ - this means that it currently won't
  973. accept attic repos (see issue #21 about improving that)
  974. Bug fixes:
  975. - avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
  976. - fix traceback when trying to do unsupported passphrase change, fixes attic #189
  977. - datetime does not like the year 10.000, fixes attic #139
  978. - fix "info" all archives stats, fixes attic #183
  979. - fix parsing with missing microseconds, fixes attic #282
  980. - fix misleading hint the fuse ImportError handler gave, fixes attic #237
  981. - check unpacked data from RPC for tuple type and correct length, fixes attic #127
  982. - fix Repository._active_txn state when lock upgrade fails
  983. - give specific path to xattr.is_enabled(), disable symlink setattr call that
  984. always fails
  985. - fix test setup for 32bit platforms, partial fix for attic #196
  986. - upgraded versioneer, PEP440 compliance, fixes attic #257
  987. New features:
  988. - less memory usage: add global option --no-cache-files
  989. - check --last N (only check the last N archives)
  990. - check: sort archives in reverse time order
  991. - rename repo::oldname newname (rename repository)
  992. - create -v output more informative
  993. - create --progress (backup progress indicator)
  994. - create --timestamp (utc string or reference file/dir)
  995. - create: if "-" is given as path, read binary from stdin
  996. - extract: if --stdout is given, write all extracted binary data to stdout
  997. - extract --sparse (simple sparse file support)
  998. - extra debug information for 'fread failed'
  999. - delete <repo> (deletes whole repo + local cache)
  1000. - FUSE: reflect deduplication in allocated blocks
  1001. - only allow whitelisted RPC calls in server mode
  1002. - normalize source/exclude paths before matching
  1003. - use posix_fadvise to not spoil the OS cache, fixes attic #252
  1004. - toplevel error handler: show tracebacks for better error analysis
  1005. - sigusr1 / sigint handler to print current file infos - attic PR #286
  1006. - RPCError: include the exception args we get from remote
  1007. Other changes:
  1008. - source: misc. cleanups, pep8, style
  1009. - docs and faq improvements, fixes, updates
  1010. - cleanup crypto.pyx, make it easier to adapt to other AES modes
  1011. - do os.fsync like recommended in the python docs
  1012. - source: Let chunker optionally work with os-level file descriptor.
  1013. - source: Linux: remove duplicate os.fsencode calls
  1014. - source: refactor _open_rb code a bit, so it is more consistent / regular
  1015. - source: refactor indicator (status) and item processing
  1016. - source: use py.test for better testing, flake8 for code style checks
  1017. - source: fix tox >=2.0 compatibility (test runner)
  1018. - pypi package: add python version classifiers, add FreeBSD to platforms
  1019. Attic Changelog
  1020. ---------------
  1021. Here you can see the full list of changes between each Attic release until Borg
  1022. forked from Attic:
  1023. Version 0.17
  1024. ~~~~~~~~~~~~
  1025. (bugfix release, released on X)
  1026. - Fix hashindex ARM memory alignment issue (#309)
  1027. - Improve hashindex error messages (#298)
  1028. Version 0.16
  1029. ~~~~~~~~~~~~
  1030. (bugfix release, released on May 16, 2015)
  1031. - Fix typo preventing the security confirmation prompt from working (#303)
  1032. - Improve handling of systems with improperly configured file system encoding (#289)
  1033. - Fix "All archives" output for attic info. (#183)
  1034. - More user friendly error message when repository key file is not found (#236)
  1035. - Fix parsing of iso 8601 timestamps with zero microseconds (#282)
  1036. Version 0.15
  1037. ~~~~~~~~~~~~
  1038. (bugfix release, released on Apr 15, 2015)
  1039. - xattr: Be less strict about unknown/unsupported platforms (#239)
  1040. - Reduce repository listing memory usage (#163).
  1041. - Fix BrokenPipeError for remote repositories (#233)
  1042. - Fix incorrect behavior with two character directory names (#265, #268)
  1043. - Require approval before accessing relocated/moved repository (#271)
  1044. - Require approval before accessing previously unknown unencrypted repositories (#271)
  1045. - Fix issue with hash index files larger than 2GB.
  1046. - Fix Python 3.2 compatibility issue with noatime open() (#164)
  1047. - Include missing pyx files in dist files (#168)
  1048. Version 0.14
  1049. ~~~~~~~~~~~~
  1050. (feature release, released on Dec 17, 2014)
  1051. - Added support for stripping leading path segments (#95)
  1052. "attic extract --strip-segments X"
  1053. - Add workaround for old Linux systems without acl_extended_file_no_follow (#96)
  1054. - Add MacPorts' path to the default openssl search path (#101)
  1055. - HashIndex improvements, eliminates unnecessary IO on low memory systems.
  1056. - Fix "Number of files" output for attic info. (#124)
  1057. - limit create file permissions so files aren't read while restoring
  1058. - Fix issue with empty xattr values (#106)
  1059. Version 0.13
  1060. ~~~~~~~~~~~~
  1061. (feature release, released on Jun 29, 2014)
  1062. - Fix sporadic "Resource temporarily unavailable" when using remote repositories
  1063. - Reduce file cache memory usage (#90)
  1064. - Faster AES encryption (utilizing AES-NI when available)
  1065. - Experimental Linux, OS X and FreeBSD ACL support (#66)
  1066. - Added support for backup and restore of BSDFlags (OSX, FreeBSD) (#56)
  1067. - Fix bug where xattrs on symlinks were not correctly restored
  1068. - Added cachedir support. CACHEDIR.TAG compatible cache directories
  1069. can now be excluded using ``--exclude-caches`` (#74)
  1070. - Fix crash on extreme mtime timestamps (year 2400+) (#81)
  1071. - Fix Python 3.2 specific lockf issue (EDEADLK)
  1072. Version 0.12
  1073. ~~~~~~~~~~~~
  1074. (feature release, released on April 7, 2014)
  1075. - Python 3.4 support (#62)
  1076. - Various documentation improvements a new style
  1077. - ``attic mount`` now supports mounting an entire repository not only
  1078. individual archives (#59)
  1079. - Added option to restrict remote repository access to specific path(s):
  1080. ``attic serve --restrict-to-path X`` (#51)
  1081. - Include "all archives" size information in "--stats" output. (#54)
  1082. - Added ``--stats`` option to ``attic delete`` and ``attic prune``
  1083. - Fixed bug where ``attic prune`` used UTC instead of the local time zone
  1084. when determining which archives to keep.
  1085. - Switch to SI units (Power of 1000 instead 1024) when printing file sizes
  1086. Version 0.11
  1087. ~~~~~~~~~~~~
  1088. (feature release, released on March 7, 2014)
  1089. - New "check" command for repository consistency checking (#24)
  1090. - Documentation improvements
  1091. - Fix exception during "attic create" with repeated files (#39)
  1092. - New "--exclude-from" option for attic create/extract/verify.
  1093. - Improved archive metadata deduplication.
  1094. - "attic verify" has been deprecated. Use "attic extract --dry-run" instead.
  1095. - "attic prune --hourly|daily|..." has been deprecated.
  1096. Use "attic prune --keep-hourly|daily|..." instead.
  1097. - Ignore xattr errors during "extract" if not supported by the filesystem. (#46)
  1098. Version 0.10
  1099. ~~~~~~~~~~~~
  1100. (bugfix release, released on Jan 30, 2014)
  1101. - Fix deadlock when extracting 0 sized files from remote repositories
  1102. - "--exclude" wildcard patterns are now properly applied to the full path
  1103. not just the file name part (#5).
  1104. - Make source code endianness agnostic (#1)
  1105. Version 0.9
  1106. ~~~~~~~~~~~
  1107. (feature release, released on Jan 23, 2014)
  1108. - Remote repository speed and reliability improvements.
  1109. - Fix sorting of segment names to ignore NFS left over files. (#17)
  1110. - Fix incorrect display of time (#13)
  1111. - Improved error handling / reporting. (#12)
  1112. - Use fcntl() instead of flock() when locking repository/cache. (#15)
  1113. - Let ssh figure out port/user if not specified so we don't override .ssh/config (#9)
  1114. - Improved libcrypto path detection (#23).
  1115. Version 0.8.1
  1116. ~~~~~~~~~~~~~
  1117. (bugfix release, released on Oct 4, 2013)
  1118. - Fix segmentation fault issue.
  1119. Version 0.8
  1120. ~~~~~~~~~~~
  1121. (feature release, released on Oct 3, 2013)
  1122. - Fix xattr issue when backing up sshfs filesystems (#4)
  1123. - Fix issue with excessive index file size (#6)
  1124. - Support access of read only repositories.
  1125. - New syntax to enable repository encryption:
  1126. attic init --encryption="none|passphrase|keyfile".
  1127. - Detect and abort if repository is older than the cache.
  1128. Version 0.7
  1129. ~~~~~~~~~~~
  1130. (feature release, released on Aug 5, 2013)
  1131. - Ported to FreeBSD
  1132. - Improved documentation
  1133. - Experimental: Archives mountable as fuse filesystems.
  1134. - The "user." prefix is no longer stripped from xattrs on Linux
  1135. Version 0.6.1
  1136. ~~~~~~~~~~~~~
  1137. (bugfix release, released on July 19, 2013)
  1138. - Fixed an issue where mtime was not always correctly restored.
  1139. Version 0.6
  1140. ~~~~~~~~~~~
  1141. First public release on July 9, 2013