Bazaar

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

  1. doc
  2. Merge into bzr.dev
Proposed by Martin Pool
Status: Merged
Approved by: Andrew Bennetts
Approved revision: no longer in the source branch.
Merged at revision: 5763
Proposed branch: lp:~mbp/bzr/doc
Merge into: lp:bzr
Diff against target: 146 lines (+15/-69)
4 files modified
bzrlib/builtins.py (+1/-32)
bzrlib/help_topics/en/conflict-types.txt (+4/-4)
doc/en/mini-tutorial/index.txt (+8/-33)
doc/en/user-guide/publishing_a_branch.txt (+2/-0)
To merge this branch: bzr merge lp:~mbp/bzr/doc
Reviewer Review Type Date Requested Status
Andrew Bennetts Approve
Review via email: mp+55872@code.launchpad.net

Commit message

fix ReST syntax; stop recommending people use SFTP in the quick guide

Description of the change

This fixes a couple of ReST syntax bugs, and stops recommending that people ought to use SFTP. (Which is one instance of https://bugs.launchpad.net/bzr/+bug/636712). For the super-short tutorial Launchpad is enough of an example.

I'll separately check in the documentation that we do describe how to set up ssh and that that is recommended over sftp.

To post a comment you must log in.
Revision history for this message
Andrew Bennetts (spiv) wrote :

Looks good!

review: Approve
Revision history for this message
Martin Pool (mbp) wrote :

sent to pqm by email

Revision history for this message
Martin Pool (mbp) wrote :

Unfortunately this was rejected because it has sphinx-specific syntax and pqm doesn't currently accept that. I'll push forward on getting the chroot updated, and I might also revert it to plain rest.

Revision history for this message
Martin Pool (mbp) wrote :

sent to pqm by email

Revision history for this message
Vincent Ladeuil (vila) wrote :

>>>>> Martin Pool <email address hidden> writes:

    > Unfortunately this was rejected because it has sphinx-specific
    > syntax and pqm doesn't currently accept that.

    > I'll push forward on getting the chroot updated, and I might also
    > revert it to plain rest.

Thanks for that ! I didn't try to push for it hoping that switching to
tarmac may offer a least resistance path, but well, we're still not
there.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py 2011-03-15 10:28:20 +0000
+++ bzrlib/builtins.py 2011-04-06 07:05:39 +0000
@@ -2788,7 +2788,7 @@
2788 bzr ignore "RE:(?!debian/).*"2788 bzr ignore "RE:(?!debian/).*"
2789 2789
2790 Ignore everything except the "local" toplevel directory,2790 Ignore everything except the "local" toplevel directory,
2791 but always ignore "*~" autosave files, even under local/::2791 but always ignore autosave files ending in ~, even under local/::
2792 2792
2793 bzr ignore "*"2793 bzr ignore "*"
2794 bzr ignore "!./local"2794 bzr ignore "!./local"
@@ -3106,32 +3106,7 @@
3106 to trigger updates to external systems like bug trackers. The --fixes3106 to trigger updates to external systems like bug trackers. The --fixes
3107 option can be used to record the association between a revision and3107 option can be used to record the association between a revision and
3108 one or more bugs. See ``bzr help bugs`` for details.3108 one or more bugs. See ``bzr help bugs`` for details.
3109
3110 A selective commit may fail in some cases where the committed
3111 tree would be invalid. Consider::
3112
3113 bzr init foo
3114 mkdir foo/bar
3115 bzr add foo/bar
3116 bzr commit foo -m "committing foo"
3117 bzr mv foo/bar foo/baz
3118 mkdir foo/bar
3119 bzr add foo/bar
3120 bzr commit foo/bar -m "committing bar but not baz"
3121
3122 In the example above, the last commit will fail by design. This gives
3123 the user the opportunity to decide whether they want to commit the
3124 rename at the same time, separately first, or not at all. (As a general
3125 rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3126 """3109 """
3127 # TODO: Run hooks on tree to-be-committed, and after commit.
3128
3129 # TODO: Strict commit that fails if there are deleted files.
3130 # (what does "deleted files" mean ??)
3131
3132 # TODO: Give better message for -s, --summary, used by tla people
3133
3134 # XXX: verbose currently does nothing
31353110
3136 _see_also = ['add', 'bugs', 'hooks', 'uncommit']3111 _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3137 takes_args = ['selected*']3112 takes_args = ['selected*']
@@ -3213,12 +3188,6 @@
3213 raise errors.BzrCommandError(3188 raise errors.BzrCommandError(
3214 "Could not parse --commit-time: " + str(e))3189 "Could not parse --commit-time: " + str(e))
32153190
3216 # TODO: Need a blackbox test for invoking the external editor; may be
3217 # slightly problematic to run this cross-platform.
3218
3219 # TODO: do more checks that the commit will succeed before
3220 # spending the user's valuable time typing a commit message.
3221
3222 properties = {}3191 properties = {}
32233192
3224 tree, selected_list = WorkingTree.open_containing_paths(selected_list)3193 tree, selected_list = WorkingTree.open_containing_paths(selected_list)
32253194
=== modified file 'bzrlib/help_topics/en/conflict-types.txt'
--- bzrlib/help_topics/en/conflict-types.txt 2010-11-24 16:28:11 +0000
+++ bzrlib/help_topics/en/conflict-types.txt 2011-04-06 07:05:39 +0000
@@ -28,11 +28,11 @@
2828
29Whatever the conflict is, resolving it is roughly done in two steps:29Whatever the conflict is, resolving it is roughly done in two steps:
3030
31- modify the working tree content so that the conflicted item is now in the311. Modify the working tree content so that the conflicted item is now in the
32 state you want to keep,32 state you want to keep, then
3333
34- inform Bazaar that the conflict is now solved and ask to cleanup any342. Inform Bazaar that the conflict is now solved and ask to cleanup any
35 remaining generated information (``bzr resolve <item>``).35 remaining generated information (``bzr resolve <item>``).
3636
37For most conflict types, there are some obvious ways to modify the working37For most conflict types, there are some obvious ways to modify the working
38tree and put it into the desired state. For some types of conflicts, Bazaar38tree and put it into the desired state. For some types of conflicts, Bazaar
3939
=== modified file 'doc/en/mini-tutorial/index.txt'
--- doc/en/mini-tutorial/index.txt 2010-11-12 22:36:19 +0000
+++ doc/en/mini-tutorial/index.txt 2011-04-06 07:05:39 +0000
@@ -140,39 +140,12 @@
140 Initial import140 Initial import
141141
142142
143Publishing your branch with SFTP143Publishing your branch on Launchpad
144================================144===================================
145145
146There are a couple of ways to publish your branch. If you already have146Launchpad is a suite of development and hosting tools for
147an SFTP server or are comfortable setting one up, you can publish your147software projects. You can use it to publish your branch. (You can
148branch to it.148also publish branches onto your own server or other hosting services.)
149
150Otherwise, skip to the next section to publish with Launchpad_, a free
151hosting service for Bazaar.
152
153.. _Launchpad: https://launchpad.net/
154
155Let's assume you want to publish your branch at ``www.example.com/myproject``::
156
157 $ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
158 2 revision(s) pushed.
159
160Bazaar will create a ``myproject`` directory on the remote server and
161push your branch to it.
162
163Now anyone can create their own copy of your branch by typing::
164
165 $ bzr branch http://www.example.com/myproject
166
167**Note**: to use SFTP, you may need to install ``paramiko`` and
168``pyCrypto``. See http://wiki.bazaar.canonical.com/InstallationFaq for details.
169
170
171Publishing your branch with Launchpad
172=====================================
173
174Launchpad is a suite of development and hosting tools for free
175software projects. You can use it to publish your branch.
176149
177If you don't have a Launchpad account, follow the `account signup guide`_150If you don't have a Launchpad account, follow the `account signup guide`_
178and `register an SSH key`_ in your new Launchpad account.151and `register an SSH key`_ in your new Launchpad account.
@@ -197,6 +170,8 @@
197history, at https://code.launchpad.net/people/+me/+junk/myproject170history, at https://code.launchpad.net/people/+me/+junk/myproject
198171
199172
173
174
200Creating your own copy of another branch175Creating your own copy of another branch
201========================================176========================================
202177
203178
=== modified file 'doc/en/user-guide/publishing_a_branch.txt'
--- doc/en/user-guide/publishing_a_branch.txt 2009-12-02 11:03:35 +0000
+++ doc/en/user-guide/publishing_a_branch.txt 2011-04-06 07:05:39 +0000
@@ -1,3 +1,5 @@
1.. _publishing_a_branch:
2
1Publishing a branch3Publishing a branch
2===================4===================
35