~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/sending_changes.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-24 07:28:16 UTC
  • mfrom: (3377.2.2 doc)
  • Revision ID: pqm@pqm.ubuntu.com-20080424072816-jjx4v6pqude11ys2
(mbp) Better help and docs for send

Show diffs side-by-side

added added

removed removed

Lines of Context:
34
34
Creating a merge directive
35
35
--------------------------
36
36
 
37
 
To create a merge directive, use the ``send`` command. For example,
38
 
this command creates a merge directive and saves it into the
39
 
nominated output file::
 
37
To create and optionally send a merge directive, use the ``send`` command. 
 
38
 
 
39
By default, ``send`` will email the merge directive to the "submission
 
40
address" for the branch, which is typically the lead developer or the
 
41
development mailing list.  
 
42
``send`` without options will create a merge directive, fire up your email
 
43
tool and attach it, ready for you to add the explanatory text bit.
 
44
(See the online help for ``send`` and
 
45
`Configuration Settings <../user-reference/bzr_man.html#configuration-settings>`_
 
46
in the User Reference for further details on how to configure this.)
 
47
 
 
48
Most projects like people to add some explanation to the mail along with
 
49
the patch, explaining the reason for the patch, and why it is done the way
 
50
it is.  This gives a reviewer some context before going into the
 
51
line-by-line diff.
 
52
 
 
53
Alternatively, if the ``--output`` (or ``-o``) option is given, ``send``
 
54
will write the merge directive to a file, so you can mail it yourself,
 
55
examine it, or save it for later use.  If an output file of ``-`` is
 
56
given, the directive is written to stdout.  For example::
40
57
 
41
58
  cd X-fix-123
42
59
  bzr send -o ../fix-123.patch
43
60
 
44
 
That file can then be emailed to a reviewer, together with an
45
 
explanation of how and why you fixed the problem the way you did, say.
46
 
 
47
 
Emailing merge directives is such a common thing that the ``send`` command
48
 
without options will create a merge directive, fire up your email
49
 
tool and attach it, ready for you to add the explanatory text bit.
50
 
See the online help for ``send`` and
51
 
`Configuration Settings <../user-reference/bzr_man.html#configuration-settings>`_
52
 
in the User Reference for further details on how to configure this.
53
61
 
54
62
Applying a merge directive
55
63
--------------------------