Browse Source

Clarification of Python 3 pip usage in documentation.

Dan Helfman 8 years ago
parent
commit
13ba5c84de
2 changed files with 9 additions and 11 deletions
  1. 1 0
      NEWS
  2. 8 11
      README.md

+ 1 - 0
NEWS

@@ -1,6 +1,7 @@
 1.1.7.dev0
 1.1.7.dev0
 
 
  * When pruning, make highest verbosity level list archives kept and pruned.
  * When pruning, make highest verbosity level list archives kept and pruned.
+ * Clarification of Python 3 pip usage in documentation.
 
 
 1.1.6
 1.1.6
 
 

+ 8 - 11
README.md

@@ -61,10 +61,10 @@ key-based ssh access to the desired user account on the remote host.
 
 
 To install borgmatic, run the following command to download and install it:
 To install borgmatic, run the following command to download and install it:
 
 
-    sudo pip install --upgrade borgmatic
+    sudo pip3 install --upgrade borgmatic
 
 
-Make sure you're using Python 3, as borgmatic does not support Python 2. (You
-may have to use "pip3" or similar instead of "pip".)
+Note that your pip binary may have a different name than "pip3". Make sure
+you're using Python 3, as borgmatic does not support Python 2.
 
 
 ## Configuration
 ## Configuration
 
 
@@ -108,10 +108,7 @@ default, the traditional /etc/borgmatic/config.yaml as well.
 In general, all you should need to do to upgrade borgmatic is run the
 In general, all you should need to do to upgrade borgmatic is run the
 following:
 following:
 
 
-    sudo pip install --upgrade borgmatic
-
-(You may have to use "pip3" or similar instead of "pip", so Python 3 gets
-used.)
+    sudo pip3 install --upgrade borgmatic
 
 
 However, see below about special cases.
 However, see below about special cases.
 
 
@@ -127,7 +124,7 @@ As of version 1.1.0, borgmatic no longer supports Python 2. If you were
 already running borgmatic with Python 3, then you can simply upgrade borgmatic
 already running borgmatic with Python 3, then you can simply upgrade borgmatic
 in-place:
 in-place:
 
 
-    sudo pip install --upgrade borgmatic
+    sudo pip3 install --upgrade borgmatic
 
 
 But if you were running borgmatic with Python 2, uninstall and reinstall instead:
 But if you were running borgmatic with Python 2, uninstall and reinstall instead:
 
 
@@ -162,8 +159,8 @@ your borgmatic configuration files.
 If you were already using Borg with atticmatic, then you can easily upgrade
 If you were already using Borg with atticmatic, then you can easily upgrade
 from atticmatic to borgmatic. Simply run the following commands:
 from atticmatic to borgmatic. Simply run the following commands:
 
 
-    sudo pip uninstall atticmatic
-    sudo pip install borgmatic
+    sudo pip3 uninstall atticmatic
+    sudo pip3 install borgmatic
 
 
 That's it! borgmatic will continue using your /etc/borgmatic configuration
 That's it! borgmatic will continue using your /etc/borgmatic configuration
 files.
 files.
@@ -252,7 +249,7 @@ borgmatic to run.
 
 
 First install tox, which is used for setting up testing environments:
 First install tox, which is used for setting up testing environments:
 
 
-    pip install tox
+    pip3 install tox
 
 
 Then, to actually run tests, run:
 Then, to actually run tests, run: