README: explicitly show how to fetch note references
[signed-off-by.git] / README
1 Do you want explicit licensing and publishing permissions for each
2 patch you incorperate into your project?  Do you miss the simplicity
3 of Signed-off-by tags you use when developing the Linux kernel and
4 Git?  This repository extracts the Developer Certificate of Origin and
5 Signed-off-by documentation from both projects, and presents them in a
6 project-agnostic manner.  To incorporate into your own project,
7
8 1. Merge the documentation into your project:
9
10     $ git remote add s-o-b git://tremily.us/signed-off-by.git
11     $ git merge s-o-b/signed-off-by
12
13 2. Tell your developers by pointing to
14    `Documentation/SubmittingPatches` from your `README` or
15    `CONTRIBUTING` documentation and sending a message to your mailing
16    list.
17
18 3. Prosper.
19
20 Branches
21 ========
22
23 To make it easier to merge bits and pieces of this documentation into
24 your project, I've split the contents into several branches:
25
26 master:
27   This branch, mostly a container for this `README`.
28
29 signed-off-by:
30   `Documentation/SubmittingPatches`, this is what you want in your
31   project.
32
33 copying:
34   The license under which `Documentation/SubmittingPatches` is
35   distributed.  Check here to determine if you are allowed to merge
36   `signed-off-by` into your project.
37
38 contributing:
39   An example `CONTRIBUTING` file in case your license does not allow
40   you to merge `signed-off-by`.  The contributing file is released
41   under the very permissive CC0 1.0 unported.
42
43 license:
44   The text of all the licenses related to this repository.  Inludes
45   `GPLv2-exact` for `SubmittingPatches`, `CC0-1.0` for `CONTRIBUTING`,
46   and `CC-BY-3.0` for `CC0-1.01`.  It also includes the short,
47   human-readable versions of the CC licenses.
48
49 Borrowed commits
50 ================
51
52 For work that started in other projects (e.g. the Linux kernel and
53 Git), I've cherry-picked the relevant commits from the project
54 repositories to preserve commit metadata.  For each of these commits,
55 I've attached a note with the commit hash, original commit message,
56 and original commit repository.  Fetch the `refs/notes/commits`
57 reference from my public repository if you want these notes:
58
59   $ git config --add remote.origin.fetch '+refs/notes/*:refs/notes/*'
60   $ git fetch origin
61
62 If I altered the original patch by removing context, I've added my
63 s-o-b.  Otherwise the original patch applied cleanly, and I left my
64 s-o-b off.