]> arthur.barton.de Git - bup.git/blobdiff - README.md
projects / bup.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix tindex for python 3
[bup.git] / README.md
diff --git a/README.md b/README.md
index 267bf7e35ebc6945d514bfdf6b88a5e62b53bde9..518d62ac9a3d3536e44a6964eef0804d388f72bd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -67,12 +67,12 @@ bup has a few advantages over other backup software:
 Reasons you might want to avoid bup
 -----------------------------------
 
 Reasons you might want to avoid bup
 -----------------------------------
 
- - This is a very early version. Therefore it will most probably not work
-   for you, but we don't know why.  It is also missing some
-   probably-critical features.
+ - It's not remotely as well tested as something like tar, so it's
+   more likely to eat your data.  It's also missing some
+   probably-critical features, though fewer than it used to be.
    
  - It requires python >= 2.6, a C compiler, and an installed git
    
  - It requires python >= 2.6, a C compiler, and an installed git
-   version >= 1.5.3.1.  It also requires par2 if you want fsck to be
+   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.
  
    able to generate the information needed to recover from some types
    of corruption.
  
@@ -86,6 +86,9 @@ Reasons you might want to avoid bup
 Notable changes introduced by a release
 =======================================
 
 Notable changes introduced by a release
 =======================================
 
+ - <a href="note/0.30-from-0.29.3.md">Changes in 0.30 as compared to 0.29.3</a>
+ - <a href="note/0.29.3-from-0.29.2.md">Changes in 0.29.3 as compared to 0.29.2</a>
+ - <a href="note/0.29.2-from-0.29.1.md">Changes in 0.29.2 as compared to 0.29.1</a>
  - <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.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>
@@ -93,6 +96,14 @@ Notable changes introduced by a release
  - <a href="note/0.27.1-from-0.27.md">Changes in 0.27.1 as compared to 0.27</a>
 
 
  - <a href="note/0.27.1-from-0.27.md">Changes in 0.27.1 as compared to 0.27</a>
 
 
+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.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) |
+
 Getting started
 ===============
 
 Getting started
 ===============
 
@@ -103,6 +114,15 @@ From source
  
         git clone https://github.com/bup/bup
 
  
         git clone https://github.com/bup/bup
 
+ - This will leave you on the master branch, which is perfect if you
+   would like to help with development, but if you'd just like to use
+   bup, please check out the latest stable release like this:
+
+        git checkout 0.29.1
+
+   You can see the latest stable release here:
+   https://github.com/bup/bup/releases.
+
  - Install the required python libraries (including the development
    libraries).
 
  - Install the required python libraries (including the development
    libraries).
 
@@ -144,7 +164,11 @@ From source
        
  - Run the tests:
  
        
  - Run the tests:
  
-        make test
+        make long-check
+
+    or if you're in a bit more of a hurry:
+
+        make check
        
     The tests should pass.  If they don't pass for you, stop here and
     send an email to bup-list@googlegroups.com.  Though if there are
        
     The tests should pass.  If they don't pass for you, stop here and
     send an email to bup-list@googlegroups.com.  Though if there are
@@ -200,7 +224,9 @@ Using bup
         bup help restore
         ...
 
         bup help restore
         ...
 
- - Initialize the default BUP_DIR (~/.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):
 
         bup init
 
 
         bup init
 
@@ -287,7 +313,7 @@ Using bup
  - Look at how little extra space your second backup used on top of
    the first:
  
  - Look at how little extra space your second backup used on top of
    the first:
  
-       du -s ~/.bup
+        du -s ~/.bup
        
  - Restore the first tar backup again (the ~1 is git notation for "one
    older than the most recent"):
        
  - Restore the first tar backup again (the ~1 is git notation for "one
    older than the most recent"):
@@ -348,7 +374,7 @@ Notes on NetBSD/pkgsrc
    traversal code ("fts") in NetBSD's libc will interpret this as a
    cycle and error out, so "ls -R" and "find" will not work.
 
    traversal code ("fts") in NetBSD's libc will interpret this as a
    cycle and error out, so "ls -R" and "find" will not work.
 
- - There is no support for ACLs.  If/when some entrprising person
+ - There is no support for ACLs.  If/when some enterprising person
    fixes this, adjust t/compare-trees.
 
 
    fixes this, adjust t/compare-trees.
 
 
@@ -508,7 +534,7 @@ mailing list (see below) if you'd like to help.
     
  - bup needs better documentation.
  
     
  - bup needs better documentation.
  
-    According to a recent article about bup in Linux Weekly News
+    According to an article about bup in Linux Weekly News
     (https://lwn.net/Articles/380983/), "it's a bit short on examples and
     a user guide would be nice."  Documentation is the sort of thing that
     will never be great unless someone from outside contributes it (since
     (https://lwn.net/Articles/380983/), "it's a bit short on examples and
     a user guide would be nice."  Documentation is the sort of thing that
     will never be great unless someone from outside contributes it (since
Alex' bup ("It backs things up") development repository