summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorben <ben@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109>2002-11-24 08:53:59 +0000
committerben <ben@2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109>2002-11-24 08:53:59 +0000
commit138166e1c4c15c3bfa34c31eda066c93bd1d2228 (patch)
treee32867ea8e9b8c5067ca1adf72563b87fbfb3cb5
parent2406e6f743eba7a00152e39f815690b87d84aaf0 (diff)
downloadrdiff-backup-138166e1c4c15c3bfa34c31eda066c93bd1d2228.tar.gz
Added some documentation and examples
git-svn-id: http://svn.savannah.nongnu.org/svn/rdiff-backup/trunk@233 2b77aa54-bcbc-44c9-a7ec-4f6cf2b41109
-rw-r--r--rdiff-backup/rdiff_backup/rpath.py14
-rw-r--r--rdiff-backup/src/rpath.py14
2 files changed, 24 insertions, 4 deletions
diff --git a/rdiff-backup/rdiff_backup/rpath.py b/rdiff-backup/rdiff_backup/rpath.py
index f091ff4..a466df8 100644
--- a/rdiff-backup/rdiff_backup/rpath.py
+++ b/rdiff-backup/rdiff_backup/rpath.py
@@ -10,10 +10,20 @@
"""Wrapper class around a real path like "/usr/bin/env"
-The RPath and associated classes make some function calls more
-convenient (e.g. RPath.getperms()) and also make working with files on
+The RPath (short for Remote Path) and associated classes make some
+function calls more convenient and also make working with files on
remote systems transparent.
+For instance, suppose
+
+rp = RPath(connection_object, "/usr/bin/env")
+
+Then rp.getperms() returns the permissions of that file, and
+rp.delete() deletes that file. Both of these will work the same even
+if "usr/bin/env" is on a different computer. So many rdiff-backup
+functions use rpaths so they don't have to know whether the files they
+are dealing with are local or remote.
+
"""
import os, stat, re, sys, shutil, gzip, socket
diff --git a/rdiff-backup/src/rpath.py b/rdiff-backup/src/rpath.py
index f091ff4..a466df8 100644
--- a/rdiff-backup/src/rpath.py
+++ b/rdiff-backup/src/rpath.py
@@ -10,10 +10,20 @@
"""Wrapper class around a real path like "/usr/bin/env"
-The RPath and associated classes make some function calls more
-convenient (e.g. RPath.getperms()) and also make working with files on
+The RPath (short for Remote Path) and associated classes make some
+function calls more convenient and also make working with files on
remote systems transparent.
+For instance, suppose
+
+rp = RPath(connection_object, "/usr/bin/env")
+
+Then rp.getperms() returns the permissions of that file, and
+rp.delete() deletes that file. Both of these will work the same even
+if "usr/bin/env" is on a different computer. So many rdiff-backup
+functions use rpaths so they don't have to know whether the files they
+are dealing with are local or remote.
+
"""
import os, stat, re, sys, shutil, gzip, socket