]> arthur.barton.de Git - bup.git/blobdiff - README.md
Update base_version to 0.34~ for 0.34 development
[bup.git] / README.md
index 8b8445d4d5a8bf23a1e0d1ff8ba3d6d46c4508b2..2d46819d3f4a0c16063b0caee2b4bd092ee1b5c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,27 +71,22 @@ Reasons you might want to avoid bup
    more likely to eat your data.  It's also missing some
    probably-critical features, though fewer than it used to be.
    
- - It requires python 3.7 or newer (or 2.7 for a bit longer), a C
-   compiler, and an installed git version >= 1.5.6.  It also requires
-   par2 if you want fsck to be able to generate the information needed
-   to recover from some types of corruption.  While python 2.7 is
-   still supported, please make plans to upgrade.  Python 2 upstream
-   support ended on 2020-01-01, and we plan to drop support soon too.
+ - It requires python 3.7 or newer, a C compiler, and an installed git
+   version >= 1.5.6.  It also requires par2 if you want fsck to be
+   able to generate the information needed to recover from some types
+   of corruption.
  
  - It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
    Solaris, or Windows (with Cygwin, and WSL).  Patches to support
    other platforms are welcome.
 
- - Until resolved, a [glibc bug](https://sourceware.org/bugzilla/show_bug.cgi?id=26034)
-   might cause bup to crash on startup for some (unusual) command line
-   argument values, when bup is configured to use Python 3.
-
  - Any items in "Things that are stupid" below.
 
 
 Notable changes introduced by a release
 =======================================
 
+ - <a href="note/0.33-from-0.32.md">Changes in 0.33 as compared to 0.32</a>
  - <a href="note/0.32-from-0.31.md">Changes in 0.32 as compared to 0.31</a>
  - <a href="note/0.31-from-0.30.1.md">Changes in 0.31 as compared to 0.30.1</a>
  - <a href="note/0.30.1-from-0.30.md">Changes in 0.30.1 as compared to 0.30</a>
@@ -108,9 +103,9 @@ Notable changes introduced by a release
 Test status
 ===========
 
-| master | 0.30.x | 0.29.x |
-|--------|--------|--------|
-| [![master branch test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master)](https://cirrus-ci.com/github/bup/bup) | [![0.30 branch test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.30.x)](https://cirrus-ci.com/github/bup/bup) | [![0.29 branch test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x)](https://cirrus-ci.com/github/bup/bup) |
+| master |
+|--------|
+| [![master branch test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master)](https://cirrus-ci.com/github/bup/bup) |
 
 Getting started
 ===============
@@ -129,15 +124,20 @@ From source
    bup, please check out the latest stable release like this:
 
     ```sh
-    git checkout 0.32
+    git checkout 0.33
     ```
 
    You can see the latest stable release here:
-   https://github.com/bup/bup/releases.
+   https://github.com/bup/bup/tags
 
  - Install the required python libraries (including the development
    libraries).
 
+   For `bup fuse` you will need to install
+   [python-fuse](https://github.com/libfuse/python-fuse) rather than
+   [fusepy](https://github.com/fusepy/fusepy).  For example, in
+   Debian, install python3-fuse rather than python3-fusepy.
+
    On very recent Debian/Ubuntu versions, this may be sufficient (run
    as root):
 
@@ -148,7 +148,7 @@ From source
    Otherwise try this:
 
     ```sh
-    apt-get install python3.7-dev python3-fuse
+    apt-get install python3-dev python3-fuse
     apt-get install python3-pyxattr python3-pytest
     apt-get install python3-distutils
     apt-get install pkg-config linux-libc-dev libacl1-dev
@@ -159,33 +159,6 @@ From source
     apt-get install python3-tornado # optional (bup web)
 
     ```
-   Or, if you can't yet migrate to Python 3 (please try to soon):
-
-    ```sh
-    apt-get install python2.7-dev python-fuse
-    apt-get install python-pyxattr python-pytest
-    apt-get install pkg-config linux-libc-dev libacl1-dev
-    apt-get install gcc make acl attr rsync
-    apt-get isntall python-pytest-xdist # optional (parallel tests)
-    apt-get install par2 # optional (error correction)
-    apt-get install libreadline-dev # optional (bup ftp)
-    apt-get install python-tornado # optional (bup web)
-    ```
-
-   On CentOS (for CentOS 6, at least), this should be sufficient (run
-   as root):
-
-    ```sh
-    yum groupinstall "Development Tools"
-    yum install python2 python2-devel libacl-devel pylibacl
-    yum install fuse-python pyxattr
-    yum install perl-Time-HiRes
-    yum install readline-devel # optional (bup ftp)
-    yum install python-tornado # optional (bup web)
-    ```
-
-   In addition to the default CentOS repositories, you may need to add
-   RPMForge (for fuse-python) and EPEL (for pyxattr).
 
    On Cygwin, install python, make, rsync, and gcc4.
 
@@ -251,6 +224,13 @@ From source
    `config/config.var/bup-python-config`, and you can change the
    selection by re-running `./configure`.
 
+- If you want to specify your own `CPPFLAGS`, `CFLAGS`, or `LDFLAGS`,
+  you can set them for individual `make` invocations, e.g. `make
+  CFLAGS=-O0 check`, or persistently via `./configure` with
+  `CFLAGS=-O0 ./configure`.  At the moment, `make clean` clears the
+  configuration, but we may change that at some point, perhaps by
+  adding and requiring a `make distclean` to clear the configuration.
+
 From binary packages
 --------------------
 
@@ -285,9 +265,9 @@ Using bup
     ...
     ```
 
- - Initialize the default BUP_DIR (~/.bup -- you can choose another by
-   either specifying `bup -d DIR ...` or setting the `BUP_DIR`
-   environment variable for a command):
+ - Initialize the default bup repository (~/.bup -- you can choose
+   another by either specifying `bup -d DIR ...` or setting the
+   `BUP_DIR` environment variable for a command):
 
     ```sh
     bup init
@@ -444,10 +424,8 @@ That's all there is to it!
 Notes on FreeBSD
 ----------------
 
-- FreeBSD's default 'make' command doesn't like bup's Makefile. In order to
-  compile the code, run tests and install bup, you need to install GNU Make
-  from the port named 'gmake' and use its executable instead in the commands
-  seen above. (i.e. 'gmake test' runs bup's test suite)
+- In order to compile the code, run tests and install bup, you need to
+  install GNU Make from the `gmake` port.
 
 - Python's development headers are automatically installed with the 'python'
   port so there's no need to install them separately.
@@ -599,8 +577,8 @@ mailing list (see below) if you'd like to help.
    __setitem__, and __setslice__ [3].
 
      [1] http://comments.gmane.org/gmane.comp.sysutils.backup.bup/613
-     [2] http://docs.python.org/2/library/mmap.html
-     [3] http://docs.python.org/2/reference/datamodel.html#emulating-container-types
+     [2] http://docs.python.org/3/library/mmap.html
+     [3] http://docs.python.org/3/reference/datamodel.html#emulating-container-types
 
  - 'bup index' is slower than it should be.
  
@@ -617,18 +595,6 @@ 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 only has experimental support for pruning old backups.
-
-   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.
-
-   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.