Merge lp:~lifeless/bzr/docs into lp:bzr

Proposed by Robert Collins
Status: Merged
Approved by: John A Meinel
Approved revision: no longer in the source branch.
Merged at revision: 5336
Proposed branch: lp:~lifeless/bzr/docs
Merge into: lp:bzr
Diff against target: 13 lines (+3/-0)
1 file modified
bzrlib/workingtree.py (+3/-0)
To merge this branch: bzr merge lp:~lifeless/bzr/docs
Reviewer Review Type Date Requested Status
John A Meinel Approve
Review via email: mp+29250@code.launchpad.net

Commit message

Document the basedir on WorkingTree.

Description of the change

Document the basedir on WorkingTree.

To post a comment you must log in.
Revision history for this message
John A Meinel (jameinel) wrote :

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Robert Collins wrote:
> Robert Collins has proposed merging lp:~lifeless/bzr/docs into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
>
>
> Document the basedir on WorkingTree.
>

I would recommend mentioning that it is a Unicode *path* and not a URL.
Possibly with an example:

  wt = workingtree.WorkingTree.open(u'/path/to/f\xf3\xf2')

  wt.basedir == u'/path/to/f\xf3\xf2'
  wt.branch.base == 'file:///path/to/f%C3%B3%C3%B2')

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkwzQqsACgkQJdeBCYSNAANcFwCgxhtYyb1QnjJrMKSwCYP+vo57
6ZkAnRcHGdaMbRKL1safgZs+BYo0/osU
=RTgF
-----END PGP SIGNATURE-----

Revision history for this message
John A Meinel (jameinel) wrote :

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Robert Collins wrote:
> Robert Collins has proposed merging lp:~lifeless/bzr/docs into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
>
>
> Document the basedir on WorkingTree.
>

 merge: approve

Though I'd recommend tweaking slightly.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkwzQrsACgkQJdeBCYSNAAPIjQCeIrEAxcvt9Vc5BcHoshiINYHX
YkcAnAvQGbR436a0SsMLgDXRfn6KHihk
=+co7
-----END PGP SIGNATURE-----

review: Approve
Revision history for this message
Robert Collins (lifeless) wrote :

sent to pqm by email

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'bzrlib/workingtree.py'
2--- bzrlib/workingtree.py 2010-06-20 11:18:38 +0000
3+++ bzrlib/workingtree.py 2010-07-06 19:50:38 +0000
4@@ -176,6 +176,9 @@
5
6 It is possible for a `WorkingTree` to have a filename which is
7 not listed in the Inventory and vice versa.
8+
9+ :ivar basedir: The root of the tree on disk. This is a unicode path object
10+ (as opposed to a URL).
11 """
12
13 # override this to set the strategy for storing views