X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/e0f899e29f41b61464530d1a5756acdb76726cf4..2bc63b501d75bd62df97ba5c675c96254d80db39:/README diff --git a/README b/README index a68804006..ce7fd14e6 100644 --- a/README +++ b/README @@ -86,9 +86,27 @@ In both cases, a copy of the code is kept in the `elpa' repository and should be sync'd with the upstream every once in a while. This copy may include local changes, tho ideally these should be kept to a minimum. +*** Subtrees + In the `subtree' case, the copy of the code is kept here in the -corresponding `packages/' directory. You should be able to "git -merge -s subtree" from the upstream branch. +corresponding `packages/' directory. You should be able to use: + + git subtree add --prefix=packages/ + +to add your package from some remote repo, and then + + git subtree pull --prefix=packages/ + +whenever you want to update it. On older git versions you can try "git +merge -s subtree". + +When you're adding and pulling, DO NOT --SQUASH!! + +Don't worry about flooding elpa.git's commit log with your package's +commit messages. Your package is part of elpa.git. Squashing +doesn't help and only gets in the way. + +*** Externals In the `external' case, the copy of the code is not kept here but in the `externals/' branch in the `elpa' repository.