← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Martin Pool
  • Date: 2007-05-03 06:21:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2477.
  • Revision ID: mbp@sourcefrog.net-20070503062149-mkf0na5ce8j3rpzm
HACKING rest fixes from jam

Show diffs side-by-side

added added

removed removed

Lines of Context:
HACKING
106
106
changes visible to users or plugin developers. Please include a diff
107
107
against mainline if you're giving a link to a branch.
108
108
 
109
 
You can generate a bundle like this:
 
109
You can generate a bundle like this::
110
110
 
111
111
  bzr bundle > mybundle.patch
112
112
  
113
113
A .patch extension is recommended instead of .bundle as many mail clients
114
114
will send the latter as a binary file. If a bundle would be too long or your
115
115
mailer mangles whitespace (e.g. implicitly converts Unix newlines to DOS
116
 
newlines), use the merge-directive command instead like this:
 
116
newlines), use the merge-directive command instead like this::
117
117
 
118
118
  bzr merge-directive http://bazaar-vcs.org http://example.org/my_branch > my_directive.patch
119
119
 
183
183
As a starting suggestion though:
184
184
 
185
185
* create a local copy of the main development branch (bzr.dev) by using
186
 
  this command: bzr branch http://bazaar-vcs.org/bzr/bzr.dev/ bzr.dev
 
186
  this command::
 
187
  
 
188
    bzr branch http://bazaar-vcs.org/bzr/bzr.dev/ bzr.dev
187
189
   
188
190
* keep your copy of bzr.dev prestine (by not developing in it) and keep
189
191
  it up to date (by using bzr pull)
702
704
 
703
705
    0. OK.
704
706
    1. Conflicts in merge-like operations, or changes are present in
705
 
        diff-like operations. 
 
707
       diff-like operations. 
706
708
    2. Unrepresentable diff changes (i.e. binary files that we cannot show 
707
 
        a diff of).
 
709
       a diff of).
708
710
    3. An error or exception has occurred.
709
711
 
710
712
Errors are handled through Python exceptions. Exceptions should be defined
711
713
inside bzrlib.errors, so that we can see the whole tree at a glance.
712
714
 
713
715
We broadly classify errors as either being either internal or not,
714
 
depending on whether ``user_error`` is set or not.  If we think it's our
 
716
depending on whether ``internal_error`` is set or not.  If we think it's our
715
717
fault, we show a backtrace, an invitation to report the bug, and possibly
716
718
other details.  This is the default for errors that aren't specifically
717
719
recognized as being caused by a user error.  Otherwise we show a briefer
993
995
http://bazaar-vcs.org/BzrWin32Installer
994
996
 
995
997
 
996
 
:: vim: ft=rst tw=74 ai
 
998
..
 
999
   vim: ft=rst tw=74 ai