[PATCH] en/user-guide: Change 'X-repo/X-trunk' to 'project/trunk'
Jari Aalto
jari.aalto at cante.net
Tue Dec 2 16:24:40 GMT 2008
I found it a little hard to follow dashed names like 'X-repo/X-trunk',
so here is patch proposal to use simple 'project/trunk' notation.
Jari
doc/en/user-guide/organizing_branches.txt | 6 ++--
doc/en/user-guide/publishing_a_branch.txt | 34 +++++++++++++++++------------
doc/en/user-guide/reusing_a_checkout.txt | 12 +++++-----
doc/en/user-guide/using_checkouts.txt | 4 +-
4 files changed, 31 insertions(+), 25 deletions(-)
diff --git a/doc/en/user-guide/organizing_branches.txt b/doc/en/user-guide/organizing_branches.txt
index c2c7fe6..5da43c7 100644
--- a/doc/en/user-guide/organizing_branches.txt
+++ b/doc/en/user-guide/organizing_branches.txt
@@ -14,9 +14,9 @@ To create a mirror branch, set-up a shared repository
(or ``checkout``) command to create the mirror.
For example::
- bzr init-repo X-repo
- cd X-repo
- bzr branch sftp://centralhost/srv/bzr/X-repo/X-trunk
+ bzr init-repo project
+ cd project
+ bzr branch sftp://centralhost/srv/bzr/project/trunk
Task branches
-------------
diff --git a/doc/en/user-guide/publishing_a_branch.txt b/doc/en/user-guide/publishing_a_branch.txt
index 7c54548..4e522fa 100644
--- a/doc/en/user-guide/publishing_a_branch.txt
+++ b/doc/en/user-guide/publishing_a_branch.txt
@@ -14,7 +14,7 @@ Note that central shared branches typically only want to
store history, not working copies of files, so their enclosing
repository is usually creating using the ``no-trees`` option, e.g.::
- bzr init-repo --no-trees sftp://centralhost/srv/bzr/X-repo/
+ bzr init-repo --no-trees sftp://centralhost/srv/bzr/project/
You can think of this step as similar to setting up a new cvsroot or
Subversion repository. However, Bazaar gives you more flexibility
@@ -34,25 +34,31 @@ content:
Here is an example of the first way::
- bzr init-repo X-repo
- bzr init X-repo/X-trunk
- cd X-repo/X-trunk
- cp -ar ~/X . (copy files in using OS-specific tools)
- bzr add
+ bzr init-repo project (prepare local repository)
+ bzr init project/trunk
+ cd project/trunk
+ (copy development files)
+ cp -ar ~/project . (using OS-specific commands or tools)
+
+ bzr add (populate repository; start version control)
bzr commit -m "Initial import"
- (local branch has content - publish it centrally now)
- bzr push sftp://centralhost/srv/bzr/X-repo/X-trunk
+ (publish to central repository)
+ bzr push sftp://centralhost/srv/bzr/project/trunk
Here is an example of the second way::
- bzr init-repo X-repo
- cd X-repo
- bzr init sftp://centralhost/srv/bzr/X-repo/X-trunk
- bzr checkout sftp://centralhost/srv/bzr/X-repo/X-trunk
- cd X-trunk
- cp -ar ~/X . (copy files in using OS-specific tools)
+ bzr init-repo project (prepare local repository)
+ cd project
+ (prepare remote central repository)
+ bzr init sftp://centralhost/srv/bzr/project/trunk
+ (branch from central repository to local)
+ bzr checkout sftp://centralhost/srv/bzr/project/trunk
+ cd trunk (copy development files)
+ cp -ar ~/project . (using OS-specific commands or tools)
bzr add
bzr commit -m "Initial import"
+ (publish to central repository)
+ bzr push sftp://centralhost/srv/bzr/project/trunk
Note that committing inside a working tree created using
the ``checkout`` command implicitly commits the content to
diff --git a/doc/en/user-guide/reusing_a_checkout.txt b/doc/en/user-guide/reusing_a_checkout.txt
index 15e961d..5b49446 100644
--- a/doc/en/user-guide/reusing_a_checkout.txt
+++ b/doc/en/user-guide/reusing_a_checkout.txt
@@ -61,10 +61,10 @@ One possible setup is to use a lightweight checkout in combination
with a local tree-less repository. This lets you switch what you
are working on with ease. For example::
- bzr init-repo --no-trees X-repo
- cd X-repo
- bzr branch sftp://centralhost/srv/bzr/X-repo/X-trunk
- bzr checkout --lightweight X-trunk my-sandbox
+ bzr init-repo --no-trees project
+ cd project
+ bzr branch sftp://centralhost/srv/bzr/project/trunk
+ bzr checkout --lightweight trunk my-sandbox
cd my-sandbox
(hack away)
@@ -74,11 +74,11 @@ a tree-less repository. You can grab or create as many branches as you
need there and switch between them as required. For example::
(assuming in my-sandbox)
- bzr branch sftp://centralhost/srv/bzr/X-repo/X-1.0 ../X-1.0
+ bzr branch sftp://centralhost/srv/bzr/project/X-1.0 ../X-1.0
bzr switch ../X-1.0
(fix bug in 1.0)
bzr commit -m "blah, blah blah"
- bzr switch ../X-trunk
+ bzr switch ../trunk
(go back to working on the trunk)
Note: The branches may be local only or they may be bound to
diff --git a/doc/en/user-guide/using_checkouts.txt b/doc/en/user-guide/using_checkouts.txt
index 356a696..e29c365 100644
--- a/doc/en/user-guide/using_checkouts.txt
+++ b/doc/en/user-guide/using_checkouts.txt
@@ -7,7 +7,7 @@ Turning a branch into a checkout
If you have a local branch and wish to make it a checkout, use the
``bind`` command like this::
- bzr bind sftp://centralhost/srv/bzr/X-repo/X-trunk
+ bzr bind sftp://centralhost/srv/bzr/project/trunk
This is necessary, for example, after creating a central branch using
``push`` as illustrated in the previous section.
@@ -56,7 +56,7 @@ as doing so:
To get a history-less checkout in Bazaar, use the ``--lightweight``
option like this::
- bzr checkout --lightweight sftp://centralhost/srv/bzr/X-repo/X-trunk
+ bzr checkout --lightweight sftp://centralhost/srv/bzr/project/trunk
Of course, many of the benefits of a normal checkout are lost by doing
this but that's a tradeoff you can make if and when it makes sense.
More information about the bazaar
mailing list