changes.rst 55 KB

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