← Back to branch summary

~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-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/sending_changes.txt
34
34
Creating a merge directive
35
35
--------------------------
36
36
 
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
 
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::
 
40
 
 
41
  cd X-fix-123
 
42
  bzr send -o ../fix-123.patch
 
43
 
 
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
43
49
tool and attach it, ready for you to add the explanatory text bit.
44
 
(See the online help for ``send`` and
 
50
See the online help for ``send`` and
45
51
`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::
57
 
 
58
 
  cd X-fix-123
59
 
  bzr send -o ../fix-123.patch
60
 
 
 
52
in the User Reference for further details on how to configure this.
61
53
 
62
54
Applying a merge directive
63
55
--------------------------