Linux-2.6.12-rc2
[linux-3.10.git] / Documentation / BK-usage / 00-INDEX
1 bk-kernel-howto.txt: Description of kernel workflow under BitKeeper
2
3 bk-make-sum: Create summary of changesets in one repository and not
4 another, typically in preparation to be sent to an upstream maintainer.
5 Typical usage:
6         cd my-updated-repo
7         bk-make-sum ~/repo/original-repo
8         mv /tmp/linus.txt ../original-repo.txt
9
10 bksend: Create readable text output containing summary of changes, GNU
11 patch of the changes, and BK metadata of changes (as needed for proper
12 importing into BitKeeper by an upstream maintainer).  This output is
13 suitable for emailing BitKeeper changes.  The recipient of this output
14 may pipe it directly to 'bk receive'.
15
16 bz64wrap: helper script. Uncompressed input is piped to this script,
17 which compresses its input, and then outputs the uu-/base64-encoded
18 version of the compressed input.
19
20 cpcset: Copy changeset between unrelated repositories.
21 Attempts to preserve changeset user, user address, description, in
22 addition to the changeset (the patch) itself.
23 Typical usage:
24         cd my-updated-repo
25         bk changes      # looking for a changeset...
26         cpcset 1.1511 . ../another-repo
27
28 csets-to-patches: Produces a delta of two BK repositories, in the form
29 of individual files, each containing a single cset as a GNU patch.
30 Output is several files, each with the filename "/tmp/rev-$REV.patch"
31 Typical usage:
32         cd my-updated-repo
33         bk changes -L ~/repo/original-repo 2>&1 | \
34                 perl csets-to-patches
35
36 cset-to-linus: Produces a delta of two BK repositories, in the form of
37 changeset descriptions, with 'diffstat' output created for each
38 individual changset.
39 Typical usage:
40         cd my-updated-repo
41         bk changes -L ~/repo/original-repo 2>&1 | \
42                 perl cset-to-linus > summary.txt
43
44 gcapatch:  Generates patch containing changes in local repository.
45 Typical usage:
46         cd my-updated-repo
47         gcapatch > foo.patch
48
49 unbz64wrap: Reverse an encoded, compressed data stream created by
50 bz64wrap into an uncompressed, typically text/plain output.
51