PackWriter_remote: init remote_closed in __new__, not __init__

[bup.git] / README.md

diff --git a/README.md b/README.md
index f706d9ab4d78cd0619d69b945600173ccb81ea8b..807dce7885a5ced175c329685e57aabcbe1baa80 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,12 +71,10 @@ 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
@@ -88,6 +86,7 @@ Reasons you might want to avoid bup
 
  - Any items in "Things that are stupid" below.
 
+
 Notable changes introduced by a release
 =======================================
 
@@ -107,11 +106,9 @@ Notable changes introduced by a release
 Test status
 ===========
 
-| branch | Debian                                                                                                                                         | FreeBSD                                                                                                                                          | macOS                                                                                                                                        |
-|--------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
-| master | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=macos)](https://cirrus-ci.com/github/bup/bup) |
-| 0.30.x | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.30.x&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.30.x&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.30.x&task=macos)](https://cirrus-ci.com/github/bup/bup) |
-| 0.29.x | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=macos)](https://cirrus-ci.com/github/bup/bup) |
+| 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) |
 
 Getting started
 ===============
@@ -139,6 +136,11 @@ From source
  - 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):
 
@@ -160,33 +162,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.
 
@@ -252,6 +227,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
 --------------------
 
@@ -600,8 +582,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.