Author: julianfoad
Date: Wed Mar 7 10:27:15 2012
New Revision: 1297921
URL: http://svn.apache.org/viewvc?rev=1297921&view=rev
Log:
Improve doc strings of Sandbox.simple_*() test suite functions.
Modified:
subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py
Modified: subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py?rev=1297921&r1=1297920&r2=1297921&view=diff
==============================================================================
--- subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py (original)
+++ subversion/trunk/subversion/tests/cmdline/svntest/sandbox.py Wed Mar 7
10:27:15 2012
@@ -210,7 +210,8 @@ class Sandbox:
svntest.main.run_svn(False, 'update', target)
def simple_switch(self, url, target=None):
- """Switch a TARGET to URL"""
+ """Switch the WC or TARGET to URL.
+ TARGET is a relpath relative to the WC."""
if target is None:
target = self.wc_dir
else:
@@ -232,61 +233,72 @@ class Sandbox:
target)
def simple_rm(self, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Schedule TARGETS for deletion.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'rm', *targets)
def simple_mkdir(self, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Create TARGETS as directories scheduled for addition.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'mkdir', *targets)
def simple_add(self, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Schedule TARGETS for addition.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'add', *targets)
def simple_revert(self, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Revert TARGETS.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'revert', *targets)
def simple_propset(self, name, value, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Set property NAME to VALUE on TARGETS.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'propset', name, value, *targets)
def simple_propdel(self, name, *targets):
- """TARGET is a relpath relative to the WC."""
+ """Delete property NAME from TARGETS.
+ TARGETS are relpaths relative to the WC."""
assert len(targets) > 0
targets = self.ospaths(targets)
svntest.main.run_svn(False, 'propdel', name, *targets)
def simple_copy(self, source, dest):
- """SOURCE and DEST are relpaths relative to the WC."""
+ """Copy SOURCE to DEST in the WC.
+ SOURCE and DEST are relpaths relative to the WC."""
source = self.ospath(source)
dest = self.ospath(dest)
svntest.main.run_svn(False, 'copy', source, dest)
def simple_move(self, source, dest):
- """SOURCE and DEST are relpaths relative to the WC."""
+ """Move SOURCE to DEST in the WC.
+ SOURCE and DEST are relpaths relative to the WC."""
source = self.ospath(source)
dest = self.ospath(dest)
svntest.main.run_svn(False, 'move', source, dest)
def simple_repo_copy(self, source, dest):
- """SOURCE and DEST are relpaths relative to the repo root."""
+ """Copy SOURCE to DEST in the repository, committing the result with a
+ default log message.
+ SOURCE and DEST are relpaths relative to the repo root."""
svntest.main.run_svn(False, 'copy', '-m', svntest.main.make_log_msg(),
self.repo_url + '/' + source,
self.repo_url + '/' + dest)
def simple_append(self, dest, contents, truncate=False):
- """Append CONTENTS to file DEST, optionally truncating it first."""
+ """Append CONTENTS to file DEST, optionally truncating it first.
+ DEST is a relpath relative to the WC."""
open(self.ospath(dest), truncate and 'w' or 'a').write(contents)
