branch: elpa-admin
commit 26a2da8c9cad96af60be1393eff58ce9cbfd5e75
Author: rocky <ro...@gnu.org>
Commit: rocky <ro...@gnu.org>
More specific externals example.
---
README | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/README b/README
index e0c9faf..9589009 100644
--- a/README
+++ b/README
@@ -228,15 +228,28 @@ In the `external' case, the copy of the code is not kept
in `master` but in the
`externals/<pkg-name>' branch in the `elpa.git' repository.
To add a new externals package, first add this `elpa.git' repository as a
-new remote in your existing repository. Then push a local branch to a
+new remote in your existing repository.
+
+Then push a local branch to a
new remote branch in `elpa.git', named `externals/<pkgname>`. For example:
git push elpa <mybranch>:externals/<pkgname>
-Then edit the `externals-list' file as mentioned above, and push that
-change to `elpa's master branch. After it's added to the `externals-list'
-file, the package can be maintained just by pushing changes to the
-`externals/<pkgname>` branch.
+For example, let's say that you want to add `realgud-ipdb` which is currently
+checked out in `$HOME/github/realgud-ipdb`:
+
+ cd $HOME/github/realgud-ipdb
+ git remote add elpa ${USER}@git.sv.gnu.org:/srv/git/emacs/elpa.git
+ git push elpa master:refs/heads/externals/realgud-ipdb
+
+
+Then edit the `externals-list' file as mentioned above, add the line
+
+ ("realgud-ipdb" :external "https://github.com/realgud/realgud-ipdb";)
+
+and push that change to `elpa's master branch. After it's added to
+the `externals-list' file, the package can be maintained just by
+pushing changes to the `externals/<pkgname>` branch.
If you wish to check out all the external packages into the `packages'
directory, you can run the command:
