Update HACKING and README for 0.28

[bup.git] / README.md

diff --git a/README.md b/README.md
index 01c2e5dec649326161d579f95eb29eee8e0fa387..91a8264777d01c8ce29499a11e9ade709622c482 100644 (file)
--- a/README.md
+++ b/README.md
@@ -76,17 +76,23 @@ Reasons you might want to avoid bup
    able to generate the information needed to recover from some types
    of corruption.
  
- - It currently only works on Linux, MacOS X >= 10.4,
-   NetBSD, Solaris, or Windows (with Cygwin).  Patches to support
-   other platforms are welcome.
+ - It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
+   Solaris, or Windows (with Cygwin).  Patches to support other
+   platforms are welcome.
 
  - Any items in "Things that are stupid" below.
 
-   
+
+Notable changes introduced by a release
+=======================================
+
+ - <a href="note/0.28-from-0.27.1.md">Changes in 0.28 as compared to 0.27.1</a>
+ - <a href="note/0.27.1-from-0.27.md">Changes in 0.27.1 as compared to 0.27</a>
+
+
 Getting started
 ===============
 
-
 From source
 -----------
 
@@ -102,7 +108,7 @@ From source
 
             apt-get build-dep bup
 
-   Otherwise try this (substitute python2.5-dev or python2.6-dev if
+   Otherwise try this (substitute python2.6-dev or python2.5-dev if
    you have an older system):
 
             apt-get install python2.7-dev python-fuse
@@ -175,6 +181,8 @@ Binary packages of bup are known to be built for the following OSes:
     http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/sysutils/bup/
  - Arch Linux:
     https://www.archlinux.org/packages/?sort=&q=bup
+ - Fedora:
+    https://apps.fedoraproject.org/packages/bup
 
 
 Using bup
@@ -474,22 +482,20 @@ mailing list (see below) if you'd like to help.
     give the continuous-backup process a really low CPU and I/O priority so
     you wouldn't even know it was running.
 
- - bup currently has no way to prune *old* backups.
- 
-    Because of the way the packfile system works, backups become "entangled"
-    in weird ways and it's not actually possible to delete one pack
-    (corresponding approximately to one backup) without risking screwing up
-    other backups.
-   
-    git itself has lots of ways of optimizing this sort of thing, but its
-    methods aren't really applicable here; bup packfiles are just too huge.
-    We'll have to do it in a totally different way.  There are lots of
-    options.  For now: make sure you've got lots of disk space :)
+ - bup only has experimental support for pruning old backups.
 
-    Until we fix this, one possible workaround is to just start a new
-    BUP_DIR occasionally, i.e. bup-2013-10, bup-2013-11...
+   While you should now be able to drop old saves and branches with
+   `bup rm`, and reclaim the space occupied by data that's no longer
+   needed by other backups with `bup gc`, these commands are
+   experimental, and should be handled with great care.  See the
+   man pages for more information.
 
- - bup has never been tested on anything but Linux, MacOS, and Windows+Cygwin.
+   Unless you want to help test the new commands, one possible
+   workaround is to just start a new BUP_DIR occasionally,
+   i.e. bup-2013, bup-2014...
+
+ - bup has never been tested on anything but Linux, FreeBSD, NetBSD,
+   OS X, and Windows+Cygwin.
  
     There's nothing that makes it *inherently* non-portable, though, so
     that's mostly a matter of someone putting in some effort.  (For a
@@ -512,10 +518,9 @@ mailing list (see below) if you'd like to help.
    
  - bup has no GUI.
  
-    Actually, that's not stupid, but you might consider it a limitation. 
-    There are a bunch of Linux GUI backup programs; someday I expect someone
-    will adapt one of them to use bup.
-    
+   Actually, that's not stupid, but you might consider it a
+   limitation.  See the ["Related Projects"](https://bup.github.io/)
+   list for some possible options.
     
 More Documentation
 ==================