[MERGE] Revised mini-tutorial

Matthew Revell matthew.revell at canonical.com
Wed Oct 3 11:57:04 BST 2007


On 29/09/2007, James Westby <jw+debian at jameswestby.net> wrote:

> > +Over the next five minutes, you'll learn how to XXX, XXX and XXX.
>
> Oooh, I've always wanted to learn how to XXX.

Oh! Schoolboy error :)

>
> > -Putting Existing Files Under Version Control
> > +Putting existing files under version control
>
> I'm unsure about the case change.
>
> It's inconsistent with the other docs in the source, and indeed this
> file. There could be mass change if it was preferred.

My personal preference is for sentence case, rather than title case,
as it's easier to read and I've never really seen a justification for
title case. However, consistency is important.

> > +Switch to a directory where you've already got some files, then type::
> > +
> >    $ bzr init .
>
> The dot is redundant here. No harm in having it though.

In that instance, I was following what was already in the
mini-tutorial. If it's redundant, perhaps it should go.

> > +
> > +If it looks like nothing happened, don't worry. You now have an empty
> > +Bazaar branch. Let's tell Bazaar which files your want to work with.
> > +
> >    $ bzr add
>
> Should any ignores be set up first?

Possibly. I see this doc as being a bare-bones introduction to Bazaar.
So, would most users want to set ignores? If so, then we either need
to say that it's possible or actually show how to do it.

>
> > +Creating your own branch Personal Branch
> > +========================================
>
> Capitilisation again, and the title doesn't make much sense.

Rather than just fixing my silly mistake in that title, I wonder if it
should be more descriptive. Would this be a better title? "Creating
and working with your own copy of someone else's branch"

> > +
> > +Of course, you can also make your own branch of someone else's work. Let's
> > +say you're interested interested in the Foo project::
> > +
> > +  $ bzr branch http://example.com/code/foobar.dev foobar.joe
> > +  Branched 1 revision(s).
>
> Perhaps a different name than foobar should be used here. It's probably
> not that important, but it is the same name as the previous project.

Thanks, I've changed the name in the second example.

-- 
Matthew Revell
launchpad.net

mrevell in #launchpad on Freenode



More information about the bazaar mailing list