[Pkg-bazaar-commits] ./bzr/unstable r254: - Doc cleanups from Magnus Therning
Martin Pool
mbp at sourcefrog.net
Fri Apr 10 07:43:56 UTC 2009
------------------------------------------------------------
revno: 254
committer: Martin Pool <mbp at sourcefrog.net>
timestamp: Fri 2005-04-15 11:31:21 +1000
message:
- Doc cleanups from Magnus Therning
modified:
bzrlib/branch.py
bzrlib/commands.py
bzrlib/inventory.py
bzrlib/osutils.py
bzrlib/revfile.py
bzrlib/revision.py
bzrlib/store.py
bzrlib/tree.py
doc/bitkeeper.txt
doc/formats.txt
doc/interrupted.txt
doc/python.txt
doc/todo-from-arch.txt
-------------- next part --------------
=== modified file 'bzrlib/branch.py'
--- a/bzrlib/branch.py 2005-04-13 04:52:35 +0000
+++ b/bzrlib/branch.py 2005-04-15 01:31:21 +0000
@@ -73,29 +73,29 @@
class Branch:
"""Branch holding a history of revisions.
- :todo: Perhaps use different stores for different classes of object,
+ TODO: Perhaps use different stores for different classes of object,
so that we can keep track of how much space each one uses,
or garbage-collect them.
- :todo: Add a RemoteBranch subclass. For the basic case of read-only
+ TODO: Add a RemoteBranch subclass. For the basic case of read-only
HTTP access this should be very easy by,
just redirecting controlfile access into HTTP requests.
We would need a RemoteStore working similarly.
- :todo: Keep the on-disk branch locked while the object exists.
+ TODO: Keep the on-disk branch locked while the object exists.
- :todo: mkdir() method.
+ TODO: mkdir() method.
"""
def __init__(self, base, init=False, find_root=True):
"""Create new branch object at a particular location.
- :param base: Base directory for the branch.
+ base -- Base directory for the branch.
- :param init: If True, create new control files in a previously
+ init -- If True, create new control files in a previously
unversioned directory. If False, the branch must already
be versioned.
- :param find_root: If true and init is false, find the root of the
+ find_root -- If true and init is false, find the root of the
existing branch containing base.
In the test suite, creation of new trees is tested using the
@@ -249,15 +249,15 @@
This puts the files in the Added state, so that they will be
recorded by the next commit.
- :todo: Perhaps have an option to add the ids even if the files do
+ TODO: Perhaps have an option to add the ids even if the files do
not (yet) exist.
- :todo: Perhaps return the ids of the files? But then again it
+ TODO: Perhaps return the ids of the files? But then again it
is easy to retrieve them if they're needed.
- :todo: Option to specify file id.
+ TODO: Option to specify file id.
- :todo: Adding a directory should optionally recurse down and
+ TODO: Adding a directory should optionally recurse down and
add all non-ignored children. Perhaps do that in a
higher-level method.
@@ -336,7 +336,7 @@
This does not remove their text. This does not run on
- :todo: Refuse to remove modified files unless --force is given?
+ TODO: Refuse to remove modified files unless --force is given?
>>> b = ScratchBranch(files=['foo'])
>>> b.add('foo')
@@ -360,9 +360,9 @@
>>> b.working_tree().has_filename('foo')
True
- :todo: Do something useful with directories.
+ TODO: Do something useful with directories.
- :todo: Should this remove the text or not? Tough call; not
+ TODO: Should this remove the text or not? Tough call; not
removing may be useful and the user can just use use rm, and
is the opposite of add. Removing it is consistent with most
other tools. Maybe an option.
@@ -432,7 +432,7 @@
be robust against files disappearing, moving, etc. So the
whole thing is a bit hard.
- :param timestamp: if not None, seconds-since-epoch for a
+ timestamp -- if not None, seconds-since-epoch for a
postdated/predated commit.
"""
@@ -612,7 +612,7 @@
def get_inventory(self, inventory_id):
"""Get Inventory object by hash.
- :todo: Perhaps for this and similar methods, take a revision
+ TODO: Perhaps for this and similar methods, take a revision
parameter which can be either an integer revno or a
string hash."""
i = Inventory.read_xml(self.inventory_store[inventory_id])
@@ -721,7 +721,7 @@
def write_log(self, show_timezone='original', verbose=False):
"""Write out human-readable log of commits to this branch
- :param utc: If true, show dates in universal time, not local time."""
+ utc -- If true, show dates in universal time, not local time."""
## TODO: Option to choose either original, utc or local timezone
revno = 1
precursor = None
@@ -888,9 +888,9 @@
D foo
- :todo: Get state for single files.
+ TODO: Get state for single files.
- :todo: Perhaps show a slash at the end of directory names.
+ TODO: Perhaps show a slash at the end of directory names.
"""
@@ -923,7 +923,7 @@
elif fs == '?':
show_status(fs, kind, newname)
else:
- bailout("wierd file state %r" % ((fs, fid),))
+ bailout("weird file state %r" % ((fs, fid),))
=== modified file 'bzrlib/commands.py'
--- a/bzrlib/commands.py 2005-04-14 23:43:01 +0000
+++ b/bzrlib/commands.py 2005-04-15 01:31:21 +0000
@@ -510,7 +510,7 @@
def cmd_log(timezone='original', verbose=False):
"""Show log of this branch.
- :todo: Options for utc; to show ids; to limit range; etc.
+ TODO: Options for utc; to show ids; to limit range; etc.
"""
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
@@ -518,7 +518,7 @@
def cmd_ls(revision=None, verbose=False):
"""List files in a tree.
- :todo: Take a revision or remote path and list that tree instead.
+ TODO: Take a revision or remote path and list that tree instead.
"""
b = Branch('.')
if revision == None:
=== modified file 'bzrlib/inventory.py'
--- a/bzrlib/inventory.py 2005-04-11 06:37:56 +0000
+++ b/bzrlib/inventory.py 2005-04-15 01:31:21 +0000
@@ -94,7 +94,7 @@
>>> i.id2path('2326')
'src/wibble/wibble.c'
- :todo: Maybe also keep the full path of the entry, and the children?
+ TODO: Maybe also keep the full path of the entry, and the children?
But those depend on its position within a particular inventory, and
it would be nice not to need to hold the backpointer here.
"""
=== modified file 'bzrlib/osutils.py'
--- a/bzrlib/osutils.py 2005-04-15 00:51:13 +0000
+++ b/bzrlib/osutils.py 2005-04-15 01:31:21 +0000
@@ -190,9 +190,9 @@
Something similar to 'Martin Pool <mbp at sourcefrog.net>'
- :todo: Check it's reasonably well-formed.
+ TODO: Check it's reasonably well-formed.
- :todo: Allow taking it from a dotfile to help people on windows
+ TODO: Allow taking it from a dotfile to help people on windows
who can't easily set variables.
"""
v = _get_user_id()
=== modified file 'bzrlib/revfile.py'
--- a/bzrlib/revfile.py 2005-04-10 04:19:28 +0000
+++ b/bzrlib/revfile.py 2005-04-15 01:31:21 +0000
@@ -217,7 +217,7 @@
assert self.idxfile.tell() == _RECORDSIZE * (idx + 1)
data_offset = self.datafile.tell()
- assert isinstance(data, str) # not unicode or anything wierd
+ assert isinstance(data, str) # not unicode or anything weird
self.datafile.write(data)
self.datafile.flush()
=== modified file 'bzrlib/revision.py'
--- a/bzrlib/revision.py 2005-04-06 14:06:32 +0000
+++ b/bzrlib/revision.py 2005-04-15 01:31:21 +0000
@@ -34,7 +34,7 @@
written out. This is not stored because you cannot write the hash
into the file it describes.
- :todo: Perhaps make predecessor be a child element, not an attribute?
+ TODO: Perhaps make predecessor be a child element, not an attribute?
"""
def __init__(self, **args):
self.inventory_id = None
=== modified file 'bzrlib/store.py'
--- a/bzrlib/store.py 2005-04-06 14:06:32 +0000
+++ b/bzrlib/store.py 2005-04-15 01:31:21 +0000
@@ -57,13 +57,13 @@
>>> st['123123'].read()
'goodbye'
- :todo: Atomic add by writing to a temporary file and renaming.
+ TODO: Atomic add by writing to a temporary file and renaming.
- :todo: Perhaps automatically transform to/from XML in a method?
+ TODO: Perhaps automatically transform to/from XML in a method?
Would just need to tell the constructor what class to
use...
- :todo: Even within a simple disk store like this, we could
+ TODO: Even within a simple disk store like this, we could
gzip the files. But since many are less than one disk
block, that might not help a lot.
@@ -82,7 +82,7 @@
def add(self, f, fileid, compressed=True):
"""Add contents of a file into the store.
- :param f: An open file, or file-like object."""
+ f -- An open file, or file-like object."""
# FIXME: Only works on smallish files
# TODO: Can be optimized by copying at the same time as
# computing the sum.
=== modified file 'bzrlib/tree.py'
--- a/bzrlib/tree.py 2005-04-06 14:06:32 +0000
+++ b/bzrlib/tree.py 2005-04-15 01:31:21 +0000
@@ -104,7 +104,7 @@
`dest` should not exist, and will be created holding the
contents of this tree.
- :todo: To handle subdirectories we need to create the
+ TODO: To handle subdirectories we need to create the
directories first.
:note: If the export fails, the destination directory will be
@@ -339,7 +339,7 @@
File text can be retrieved from the text store.
- :todo: Some kind of `__repr__` method, but a good one
+ TODO: Some kind of `__repr__` method, but a good one
probably means knowing the branch and revision number,
or at least passing a description to the constructor.
"""
=== modified file 'doc/bitkeeper.txt'
--- a/doc/bitkeeper.txt 2005-03-09 04:51:05 +0000
+++ b/doc/bitkeeper.txt 2005-04-15 01:31:21 +0000
@@ -6,7 +6,7 @@
keyboard navigation.
The tool itself is also a bit unfriendly in terms of emitting a lot of
-noise messages and having lots of wierd commands.
+noise messages and having lots of weird commands.
Bitkeeper always requires both per-file and per-changeset commands.
It seems bad to always require this; at most per-file messages should
=== modified file 'doc/formats.txt'
--- a/doc/formats.txt 2005-03-22 00:02:45 +0000
+++ b/doc/formats.txt 2005-04-15 01:31:21 +0000
@@ -199,7 +199,7 @@
Name of the branch to which this was originally committed.
(I'm not totally satisfied that this is the right way to do it; the
- results will be a bit wierd when a series of revisions pass through
+ results will be a bit weird when a series of revisions pass through
variously named branches.)
inventory_hash
=== modified file 'doc/interrupted.txt'
--- a/doc/interrupted.txt 2005-03-09 04:51:05 +0000
+++ b/doc/interrupted.txt 2005-04-15 01:31:21 +0000
@@ -62,7 +62,7 @@
* We can't atomically replace the whole working copy. We can
(semi) atomically updated particular files.
- * If the working copy files are in a wierd state it is hard to know
+ * If the working copy files are in a weird state it is hard to know
whether that occurred because bzr's work was interrupted or because
the user changed them.
=== modified file 'doc/python.txt'
--- a/doc/python.txt 2005-03-09 04:51:05 +0000
+++ b/doc/python.txt 2005-04-15 01:31:21 +0000
@@ -77,7 +77,7 @@
on that may well fix this.
Thirdly, we can present a Python library through a C interface; this
-might seem a bit wierd but I think it will work fine. Python is
+might seem a bit weird but I think it will work fine. Python is
easily embeddable; this might be the best way for Windows IDE
integration.
=== modified file 'doc/todo-from-arch.txt'
--- a/doc/todo-from-arch.txt 2005-03-09 04:51:05 +0000
+++ b/doc/todo-from-arch.txt 2005-04-15 01:31:21 +0000
@@ -80,7 +80,7 @@
* Autogeneration of Changelogs -- but should be in GNU format, at
least optionally. I'm not convinced auto-updating them in the tree
- is worthwhile; it makes merges wierd.
+ is worthwhile; it makes merges weird.
* Sealing branches.
More information about the Pkg-bazaar-commits
mailing list