changes.rst 55 KB

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