README: Use pull and add --allow-unrelated-histories
authorW. Trevor King <wking@tremily.us>
Wed, 11 Oct 2017 18:29:53 +0000 (11:29 -0700)
committerW. Trevor King <wking@tremily.us>
Wed, 11 Oct 2017 18:45:16 +0000 (11:45 -0700)
Using pull gets us down to a single command, leaves no local remote,
and results in a more-descriptive commit message:

  Merge branch 'signed-off-by' of git://tremily.us/signed-off-by

vs. the old:

  Merge branch 'signed-off-by' of s-o-b

--allow-unrelated-histories is required for this sort of thing since
e379fdf3 (merge: refuse to create too cool a merge by default,
2016-03-18, v2.9.0 [1]) and 09c2cb87 (pull: pass
--allow-unrelated-histories to "git merge", 2016-03-18, v2.9.0 [2]).

[1]: https://github.com/git/git/commit/e379fdf34fee96cd205be83ff4e71699bdc32b18
[2]: https://github.com/git/git/commit/09c2cb877a9cc0f6f25eac8d43663f4e8f3309a4

Signed-off-by: W. Trevor King <wking@tremily.us>
README

diff --git a/README b/README
index c886f861ba55d33e8d1f9f3342320d0d786a64c3..298afcc4e21cc949dbcb35d458695813a4138a67 100644 (file)
--- a/README
+++ b/README
@@ -5,11 +5,13 @@ Git?  This repository extracts the Developer Certificate of Origin and
 Signed-off-by documentation from both projects, and presents them in a
 project-agnostic manner.  To incorporate into your own project,
 
-1. Merge the documentation into your project:
+1. Pull the documentation into your project:
 
-    $ git remote add s-o-b git://tremily.us/signed-off-by.git
-    $ git fetch s-o-b
-    $ git merge s-o-b/signed-off-by
+     $ git pull --allow-unrelated-histories git://tremily.us/signed-off-by.git signed-off-by
+
+   Alternatively, you may pull in one of the other branches listed below, for example:
+
+     $ git pull --allow-unrelated-histories git://tremily.us/signed-off-by.git contributing-github
 
 2. Tell your developers by pointing to
    `Documentation/SubmittingPatches` from your `README` or