Merge lp:~mbp/bzr/doc into lp:bzr

Proposed by Martin Pool
Status: Merged
Approved by: Martin Pool
Approved revision: no longer in the source branch.
Merged at revision: not available
Proposed branch: lp:~mbp/bzr/doc
Merge into: lp:bzr
Diff against target: 20 lines (+11/-0)
1 file modified
doc/en/user-guide/branching_a_project.txt (+11/-0)
To merge this branch: bzr merge lp:~mbp/bzr/doc
Reviewer Review Type Date Requested Status
Ian Clatworthy Approve
Review via email: mp+21820@code.launchpad.net

Commit message

(mbp) better user documentation of urls

Description of the change

https://answers.edge.launchpad.net/bzr/+question/104081 shows someone having trouble working out they should use a tilde to indicate a homedir-relative path. This mentions it in the user guide.

It turns out this is already in 'help urlspec' but perhaps that's not easy to find.

To post a comment you must log in.
Revision history for this message
Ian Clatworthy (ian-clatworthy) :
review: Approve
Revision history for this message
Martin Pool (mbp) wrote :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/en/user-guide/branching_a_project.txt'
2--- doc/en/user-guide/branching_a_project.txt 2009-12-02 20:34:07 +0000
3+++ doc/en/user-guide/branching_a_project.txt 2010-03-22 00:34:17 +0000
4@@ -30,6 +30,17 @@
5 `URL Identifiers <../user-reference/bzr_man.html#url-identifiers>`_
6 section of the Bazaar User Reference.
7
8+URLs are normally resolved relative to the root directory of the server,
9+so ``ftp://example.com/repo/foo`` means the ``/repo/foo`` directory of
10+that host. (We say 'normally' because some server software like Apache
11+can be configured to remap URLs arbitrarily, in which case you'll need to
12+look at the server configuration to find out which URL corresponds to
13+which directory.)
14+
15+To address a path relative to your home directory on the server, use a
16+tilde like so: ``sftp://example.com/~/public_html`` should map to
17+``public_html`` within your home directory.
18+
19 A reminder about shared repositories
20 ------------------------------------
21