_helpers: fix module init, and get it at least building with py3

[bup.git] / README.md

diff --git a/README.md b/README.md
index 489cafd797ae8ee325e4ec08246eeb8e8736b771..267bf7e35ebc6945d514bfdf6b88a5e62b53bde9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -77,8 +77,8 @@ Reasons you might want to avoid bup
    of corruption.
  
  - It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
-   Solaris, or Windows (with Cygwin).  Patches to support other
-   platforms are welcome.
+   Solaris, or Windows (with Cygwin, and maybe with WSL).  Patches to
+   support other platforms are welcome.
 
  - Any items in "Things that are stupid" below.
 
@@ -86,6 +86,8 @@ Reasons you might want to avoid bup
 Notable changes introduced by a release
 =======================================
 
+ - <a href="note/0.29.1-from-0.29.md">Changes in 0.29.1 as compared to 0.29</a>
+ - <a href="note/0.29-from-0.28.1.md">Changes in 0.29 as compared to 0.28.1</a>
  - <a href="note/0.28.1-from-0.28.md">Changes in 0.28.1 as compared to 0.28</a>
  - <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>
@@ -150,13 +152,13 @@ From source
     may fail.  Running something like this before "make test" should
     sidestep the problem:
 
-        cd "$(/bin/pwd)"
+        cd "$(pwd -P)"
 
  - You can install bup via "make install", and override the default
    destination with DESTDIR and PREFIX.
 
    Files are normally installed to "$DESTDIR/$PREFIX" where DESTDIR is
-   empty by default, and PREFIX is set to /usr.  So if you wanted to
+   empty by default, and PREFIX is set to /usr/local.  So if you wanted to
    install bup to /opt/bup, you might do something like this:
 
         make install DESTDIR=/opt/bup PREFIX=''
@@ -244,9 +246,19 @@ Using bup
         bup index /etc
         bup save -r SERVERNAME:path/to/remote-bup-dir -n local-etc /etc
 
- - Restore a backup from a remote server.  (FAIL: unfortunately,
-   unlike "bup join", "bup restore" does not yet support remote
-   restores.  See both "bup join" and "Things that are stupid" below.)
+ - Make a remote backup to ~/.bup on SERVER:
+
+        bup index /etc
+        bup save -r SERVER: -n local-etc /etc
+
+ - See what saves are available in ~/.bup on SERVER:
+
+        bup ls -r SERVER:
+
+ - Restore the remote backup to ./dest:
+
+        bup restore -r SERVER: -C ./dest local-etc/latest/etc
+        ls -l dest/etc
 
  - Defend your backups from death rays (OK fine, more likely from the
    occasional bad disk block).  This writes parity information
@@ -286,11 +298,12 @@ Using bup
  
         GIT_DIR=~/.bup git log local-etc
        
- - Make a backup on a remote server:
+ - Save a tar archive to a remote server (without tar -z to facilitate
+   deduplication):
    
         tar -cvf - /etc | bup split -r SERVERNAME: -n local-etc -vv
  
- - Try restoring the remote backup tarball:
+ - Restore the archive:
  
         bup join -r SERVERNAME: local-etc | tar -tf -
        
@@ -428,16 +441,6 @@ Things that are stupid for now but which we'll fix later
 Help with any of these problems, or others, is very welcome.  Join the
 mailing list (see below) if you'd like to help.
 
- - 'bup restore' can't pull directly from a remote server.
-
-    So in one sense "save -r" is a dead-end right now.  Obviously you
-    can use "ssh SERVER bup restore -C ./dest..." to create a tree you
-    can transfer elsewhere via rsync/tar/whatever, but that's *lame*.
-
-    Until we fix it, you may be able to mount the remote BUP_DIR via
-    sshfs and then restore "normally", though that hasn't been
-    officially tested.
-
  - 'bup save' and 'bup restore' have immature metadata support.
  
     On the plus side, they actually do have support now, but it's new,