Merge lp:~patrick-regan/bzr/lp-quicktutorial into lp:bzr

Proposed by Patrick Regan
Status: Merged
Approved by: Ian Clatworthy
Approved revision: not available
Merged at revision: not available
Proposed branch: lp:~patrick-regan/bzr/lp-quicktutorial
Merge into: lp:bzr
Diff against target: 37 lines (+8/-6)
1 file modified
doc/en/mini-tutorial/index.txt (+8/-6)
To merge this branch: bzr merge lp:~patrick-regan/bzr/lp-quicktutorial
Reviewer Review Type Date Requested Status
Ian Clatworthy Approve
Andrew Bennetts Approve
Review via email: mp+15073@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Patrick Regan (patrick-regan) wrote :

Mini-tutorial had bug against it that said that the new(ish) lp: shortcut for the branch url scheme.

I added some to fix this bug. Comments and suggestions welcome.

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

Is there any reason for stressing that lp: is only supported in 0.92 several times? That release was over 2 years ago now. I'd be tempted to mention it in a note once (only). Thoughts?

review: Needs Information
Revision history for this message
Patrick Regan (patrick-regan) wrote :

> Is there any reason for stressing that lp: is only supported in 0.92 several
> times? That release was over 2 years ago now. I'd be tempted to mention it in
> a note once (only). Thoughts?

Sounds good, but where to say it? Just once the first time, or make a foot note? Should I even keep the whole URL examples?

Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

Patrick Regan wrote:
>> Is there any reason for stressing that lp: is only supported in 0.92 several
>> times? That release was over 2 years ago now. I'd be tempted to mention it in
>> a note once (only). Thoughts?
>
> Sounds good, but where to say it? Just once the first time, or make a foot note? Should I even keep the whole URL examples?

Just once the first time is sufficient.

It's worth keeping the whole URL examples I think in "Publishing your
branch with sftp". I don't think they're needed in "Publishing your
branch with Launchpad".

Ian C.

Revision history for this message
Patrick Regan (patrick-regan) wrote :

Changes according to suggestions added and pushed.

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

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

Ian Clatworthy wrote:
> Patrick Regan wrote:
>>> Is there any reason for stressing that lp: is only supported in 0.92 several
>>> times? That release was over 2 years ago now. I'd be tempted to mention it in
>>> a note once (only). Thoughts?
>> Sounds good, but where to say it? Just once the first time, or make a foot note? Should I even keep the whole URL examples?
>
> Just once the first time is sufficient.
>
> It's worth keeping the whole URL examples I think in "Publishing your
> branch with sftp". I don't think they're needed in "Publishing your
> branch with Launchpad".
>
> Ian C.

I would probably do it in a footnote. Something like:

Use[#]::

  bzr branch lp:~john-doe/foo/bar

.. [#] Versions of bzr before 0.92 did not understand the 'lp:' prefix.
       You can manually expand them to:
       ``bzr+ssh://bazaar.launchpad.net/~john-doe/foo/bar``.

The wrapping would need to be fixed, etc. But that would be the basic idea.

By the way, I always find:
http://docutils.sourceforge.net/docs/user/rst/quickref.html

To be *very* handy to keep around. When writing reStructuredText.

John
=:->

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

iEYEARECAAYFAksGsUcACgkQJdeBCYSNAAMZfgCgqfJz7iyUJWNvwmPh++XKVczI
LowAn1kYb4kOHFsRStoky9+qLLdiyNw4
=jopB
-----END PGP SIGNATURE-----

Revision history for this message
Patrick Regan (patrick-regan) wrote :

Finally got it changed. I've used a foot note. Thanks to Mr. Meinel for the link to the ReST quickref.

Revision history for this message
Andrew Bennetts (spiv) wrote :

Looks good to me, using a footnote is a good solution.

review: Approve
Revision history for this message
Ian Clatworthy (ian-clatworthy) wrote :

One minor tweak while landing: the last example can simply be ...

  bzr branch lp:bzr-gtk bzr-gtk.john

I'll tweak and merge.

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

To get this to build, I had to do:
=== modified file 'doc/en/mini-tutorial/index.txt'
--- doc/en/mini-tutorial/index.txt 2009-12-02 23:09:40 +0000
+++ doc/en/mini-tutorial/index.txt 2009-12-03 00:44:16 +0000
@@ -182,10 +182,10 @@

 Replacing ``john.doe`` with your own Launchpad username, type [#]_::

+ $ bzr push lp:~john.doe/+junk/myproject
+
 .. [#] Use of the ``lp:`` URL scheme requires bzr 0.92 or later.

- $ bzr push lp:~john.doe/+junk/myproject
-
 **Note:** ``+junk`` means that this branch isn't associated with any particular
 project in Launchpad.

I assume the issue is that the ".. [#]" can't be in the "::" block. Did you do "make doc/en/mini-tutorial/index.html" and it worked for you? Because it didn't work on PQM or on my local machine.

Revision history for this message
Patrick Regan (patrick-regan) wrote :

>
> I assume the issue is that the ".. [#]" can't be in the "::" block. Did you
> do "make doc/en/mini-tutorial/index.html" and it worked for you? Because it
> didn't work on PQM or on my local machine.

I didn't actually (/me has a shameful look). I was at work on one of my
breaks for that edit, so I didn't have an environment with docutils
installed. I should have just waited to push it until I got home.

Won't happen again.

Pat

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

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

Patrick Regan wrote:
>> I assume the issue is that the ".. [#]" can't be in the "::" block. Did you
>> do "make doc/en/mini-tutorial/index.html" and it worked for you? Because it
>> didn't work on PQM or on my local machine.
>
>
> I didn't actually (/me has a shameful look). I was at work on one of my
> breaks for that edit, so I didn't have an environment with docutils
> installed. I should have just waited to push it until I got home.
>
> Won't happen again.
>
> Pat
>

I wouldn't worry too much about "Won't happen again". Accidents happen,
and its why we have a PQM, a test suite, and code review in the first place.

Just a recommendation to make sure you check results before submission
as much is reasonable.

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

iEYEARECAAYFAksX2cIACgkQJdeBCYSNAAPfTgCeIJp/HR9RDgIGlbyQ+hWj4nyK
UXcAoK/QNZmXabubEY5/gi3i5e7j4QU8
=9Dng
-----END PGP SIGNATURE-----

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'doc/en/mini-tutorial/index.txt'
--- doc/en/mini-tutorial/index.txt 2009-09-02 16:03:51 +0000
+++ doc/en/mini-tutorial/index.txt 2009-11-24 14:37:11 +0000
@@ -180,17 +180,19 @@
180.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount180.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
181.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys181.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
182182
183Replacing ``john.doe`` with your own Launchpad username, type::183Replacing ``john.doe`` with your own Launchpad username, type [#]_::
184184
185 $ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject185.. [#] Use of the ``lp:`` URL scheme requires bzr 0.92 or later.
186
187 $ bzr push lp:~john.doe/+junk/myproject
186188
187**Note:** ``+junk`` means that this branch isn't associated with any particular189**Note:** ``+junk`` means that this branch isn't associated with any particular
188project in Launchpad.190project in Launchpad.
189191
190Now, anyone can create their own copy of your branch by typing::192Now, anyone can create their own copy of your branch by typing::
191193
192 $ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject194 $ bzr branch lp:~john.doe/+junk/myproject
193 195
194You can also see information about your branch, including its revision196You can also see information about your branch, including its revision
195history, at https://code.launchpad.net/people/+me/+junk/myproject197history, at https://code.launchpad.net/people/+me/+junk/myproject
196198
@@ -201,7 +203,7 @@
201To work with someone else's code, you can make your own copy of their 203To work with someone else's code, you can make your own copy of their
202branch. Let's take a real-world example, Bazaar's GTK interface::204branch. Let's take a real-world example, Bazaar's GTK interface::
203205
204 $ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john206 $ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
205 Branched 292 revision(s). 207 Branched 292 revision(s).
206208
207Bazaar will download all the files and complete revision history from the209Bazaar will download all the files and complete revision history from the