Signed-off-by: Miklos Vajna <vmiklos@xxxxxxxxxxxxxx> --- Here comes the 3rd try. I wonder if I should remove the mail header :) The commands are from the mail, but the patch itself now are more based on the suggestions by Junio (and reworded / reorganized). Sorry for the late reply, I had some problem with my mail setup. Documentation/Makefile | 2 +- Documentation/howto/use-merge-subtree.txt | 71 +++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 1 deletions(-) create mode 100644 Documentation/howto/use-merge-subtree.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 7b0685b..4addb8a 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -23,7 +23,7 @@ ARTICLES += everyday ARTICLES += git-tools ARTICLES += glossary # with their own formatting rules. -SP_ARTICLES = howto/revert-branch-rebase user-manual +SP_ARTICLES = howto/revert-branch-rebase howto/use-merge-subtree user-manual API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) SP_ARTICLES += $(API_DOCS) SP_ARTICLES += technical/api-index diff --git a/Documentation/howto/use-merge-subtree.txt b/Documentation/howto/use-merge-subtree.txt new file mode 100644 index 0000000..2f4f38a --- /dev/null +++ b/Documentation/howto/use-merge-subtree.txt @@ -0,0 +1,71 @@ +Date: Sat, 5 Jan 2008 20:17:40 -0500 +From: Sean <seanlkml@xxxxxxxxxxxx> +To: Miklos Vajna <vmiklos@xxxxxxxxxxxxxx> +Cc: git@xxxxxxxxxxxxxxx +Subject: Re: how to use git merge -s subtree? +Abstract: In this article, Sean demonstrates how one can use the subtree merge + strategy. +Message-ID: <BAYC1-PASMTP12374B54BA370A1E1C6E78AE4E0@xxxxxxx> + +How to use the subtree merge strategy +===================================== + +There are situations where you want to include contents in your project from an +independently developed project. You can just pull from the other project as +long as there are no conflicting paths. + +The problematic case is when there are conflicting files. Potential candidates +are Makefiles and other standard filenames. You could merge these files but +probably you do not want. A better solution for this problem can be to merge +the project to its own subdirectory. This is not supported by the 'recursive' +merge strategy, so just pulling won't work. + +What you want is the 'subtree' merge strategy, which helps you in such a +situation. + +In this example, let's say you have the repository at `/path/to/B` (but it can +be an URL as well, if you want). You want to merge the 'master' branch of that +repository to the `dir-B` subdirectory in your current branch. + +Here are all the commands you need: + +---------------- +$ git remote add -f Bproject /path/to/B <1> +$ git merge -s ours --no-commit Bproject/master <2> +$ git read-tree --prefix=dir-B/ -u Bproject/master <3> +$ git commit -m "Merge B project as our subdirectory" <4> + +$ git pull -s subtree Bproject master <5> +---------------- +<1> name the other project "Bproject", and fetch. +<2> prepare for the later step to record the result as a merge. +<3> read "master" branch of Bproject to the subdirectory "dir-B". +<4> record the merge result. +<5> maintain the result with subsequent merges using "subtree" + +The first four commands are necessary for the initial merge, while the last one +should be used to merge updates from 'B project'. + +Comparing 'subtree' merge with submodules +----------------------------------------- + +- The benefit of using subtree merge is that it requires less attention from + the users of your repository. It works with older (before Git v1.5.2) clients + and you have the code right after clone. + +- However if you use submodules then you can choose not to transfer the + submodule objects. This may be a problem with the subtree merge. + +- Also, in case you make changes to the other project, it is easier to submit + changes if you just use submodules. + +Additional tips +--------------- + +- If you made changes to the other project in your repository, they may want to + merge from your project. This is possible using subtree -- it can shift up + the paths in your tree and then they can merge only the relevant parts of + your tree. + +- Please note that if the other project merges from you, then it will connects + its history to yours, which can be something they don't want to. -- 1.5.4.rc2-dirty - To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
