~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Aaron Bentley
  • Date: 2007-11-06 18:32:59 UTC
  • Revision ID: abentley@panoramicfeedback.com-20071106183259-vloyvi863z7q6jrc
Tags: release-0.92.1
Fix ImportReplacer glitch when bzrtools is out of date

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
BZR TOOLS
2
2
 
3
 
This is is a set of helper tools for bzr.
4
 
 
5
 
BAZ2BZR
6
 
baz2bzr will import an Arch or Baz branch into bzr.
 
3
This is is a set of plugins for Bazaar.
 
4
 
 
5
Please report bugs to Aaron Bentley <aaron.bentley@utoronto.ca>
 
6
 
 
7
 
 
8
BAZ-IMPORT
 
9
baz-import will import an Arch or Baz Archive into a bzr repository.
7
10
Data converted:
8
11
- source tree
9
12
- file ids
10
13
- revision ids
11
 
- log summaries
12
 
 
13
 
Data not converted:
14
 
- data on revisions merged
15
 
- log bodies
16
 
- symlinks in Arch trees are not handled (but can be skipped).
17
 
 
18
 
After more commits are made to the baz/arch branch, you can re-run baz2bzr
 
14
- logs
 
15
- merge data
 
16
 
 
17
After more commits are made to the baz/arch branch, you can re-run baz-import
19
18
to import just those changes.
20
19
 
21
 
The conversion algorithm is still in flux, and old data may become invalid as
22
 
newer conversion functionality is introduced.
23
 
 
24
 
 
25
 
BZR-PUSH
 
20
BAZ-IMPORT-BRANCH
 
21
baz-import-branch will import an Arch or Baz Branch into a bzr standalone tree.
 
22
See baz-import for conversion details.
 
23
 
 
24
BRANCHES
 
25
List all the branches present at, or underneath, a location.
 
26
 
 
27
BRANCH-HISTORY
 
28
Show a history of the branch, separated by committer and branch nick.
 
29
 
 
30
CBRANCH
 
31
Create a branch in a repository and a checkout elsewhere, in one command.
 
32
 
 
33
CDIFF
 
34
cdiff mimics bzr diff, but displays the diff in colour. cdiff knows how
 
35
to read a ~/.colordiffrc file, in the same format as for colordiff(1).
 
36
 
 
37
# example ~/.colordiffrc
 
38
plain=darkwhite
 
39
newtext=darkblue
 
40
oldtext=darkred
 
41
diffstuff=darkgreen
 
42
 
 
43
CLEAN-TREE
 
44
Delete unknown, ignored, or detritus files, leaving versioned files untouched.
 
45
 
 
46
FETCH-GHOSTS
 
47
Scan this branch for missing ancestors (aka "ghosts), and attempt to retrieve
 
48
them from a specified branch.
 
49
 
 
50
GRAPH-ANCESTRY
 
51
Use dot (from Graphviz) to produce graphics of a tree's ancestry.
 
52
 
 
53
IMPORT
 
54
Import a tarball into a bzr branch, or update to a fresh tarball.
 
55
 
 
56
PATCH
 
57
Use patch to apply a patch to this tree.
 
58
 
 
59
MULTI-PULL
 
60
Pull all branches and checkouts at or underneath the current location.
 
61
 
 
62
RSPUSH
26
63
Uses rsync to copy a branch to a remote location.  Remembers the last location
27
64
used.  Will not push if
28
65
- there are unknown files
29
66
- there are uncommitted changes in the working tree.
30
67
These safeguards are intended to prevent dirty trees from being uploaded.
31
68
 
32
 
ANNOTATE
33
 
Output a version of the requested file that indicates which revision introduced
34
 
each line.
35
 
 
36
 
SHELF/UNSHELF
37
 
Temporarily put aside some changes, to restore them later.  This can be useful
38
 
to separate two sets of changes, so that they can be committed separately.
39
 
 
40
 
BZR-PULL (obsolete as of Bzr 0.5)
41
 
Uses rsync to get the latest changes from an upstream location.  Remembers the
42
 
last location used.  Will not pull if
43
 
- there are unknown files
44
 
- there are uncommitted changes
45
 
- there have been local commits
46
 
These safeguards are intended to prevent accidental data loss.
 
69
SHELL
 
70
An interactive shell with bzr commands available as single commands, and
 
71
nice shell completion.
 
72
 
 
73
SHELVE/UNSHELVE/SHELF
 
74
Shelve allows you to temporarily put changes you've made "on the shelf",
 
75
ie. out of the way, until a later time when you can bring them back from
 
76
the shelf with the 'unshelve' command.
 
77
 
 
78
You can put multiple items on the shelf, each time you run unshelve the
 
79
most recently shelved changes will be reinstated.
 
80
 
 
81
If filenames are specified, only the changes to those files will be
 
82
shelved, other files will be left untouched.
 
83
 
 
84
If a revision is specified, changes since that revision will be shelved.
 
85
 
 
86
If you specifiy "--pick" you'll be prompted for each hunk of the diff as
 
87
to whether you want to shelve it or not. Press "?" at the prompt for help.
 
88
 
 
89
SHOW-PATHS
 
90
List the locations used by a branch or checkout.
 
91
 
 
92
More Info
 
93
=========
 
94
 
 
95
http://bazaar.canonical.com/BzrShelveExample
 
96
 
 
97
SWITCH
 
98
Change the branch associated with a lightweight checkout, and update the tree
 
99
while retaining local changes.
 
100
 
 
101
ZAP
 
102
Safely remove undesired checkouts.