Skip to content
Browse files

Document the :checkout property of hg recipe

  • Loading branch information...
1 parent 22cdc93 commit 7449bdbf3e176250ccec322228a490580851637e @tkf tkf committed
Showing with 16 additions and 5 deletions.
  1. +15 −4 el-get-custom.el
  2. +1 −1 el-get.el
View
19 el-get-custom.el
@@ -113,6 +113,9 @@ definition provided by `el-get' recipes locally.
`github' and `emacsmirror', which are derived form `git').
Also supported in the installer in `el-get-install'.
+ For a `hg' recipe, `:checkout' can be used to specify a
+ branch to use.
+
:url
Where to fetch the package, only meaningful for `git' and
@@ -301,12 +304,14 @@ definition provided by `el-get' recipes locally.
with the following meaning:
* `http', `ftp' and `emacswiki' with the SHA1 of the downloaded file
- * `git' in which it is an alias for `:checkout' (see below)
+ * `git' and `hg' in which it is an alias for `:checkout' (see below)
:checkout
- A git refspec (branch, tag, commit hash) that should be
- checked out after cloning the git repository. If provided,
+ A git refspec or hg revision specifier.
+
+ For a git recipe, this is a refspec (branch, tag, commit hash) that
+ should be checked out after cloning the git repository. If provided,
this overrides any value for the `:branch' property. Unlike
the `:branch' property, this can be any valid argument to
`git checkout', including a tag name or a commit hash. The
@@ -314,7 +319,13 @@ definition provided by `el-get' recipes locally.
a particular revision, regardless of what happens to the repo
upstream.
- Currently this property only has meaning for `git' type
+ For a hg recipe, this is a revision specifier (branch, tag,
+ changeset id, \"tip\") that can be given to the `hg update'
+ command. Although the revision number can be used, it is
+ recommended not to because it can point to a different
+ revision in another clone of the package repository.
+
+ Currently this property only has meaning for `git' and `hg' type
recipes. Other VCS-based methods may implement support in the
future.
View
2 el-get.el
@@ -47,7 +47,7 @@
;; - add support for el-get-reload and do that at update time
;; - implement :checksum property for http kinds of files
;; - Add new command el-get-reinstall
-;; - implement :checkout property for git packages
+;; - implement :checkout property for git and hg packages
;; - implement :shallow property for git packages
;; - add support for auto-building of ELPA recipes
;; - implement :submodule property for git packages (allow bypassing them)

0 comments on commit 7449bdb

Please sign in to comment.
Something went wrong with that request. Please try again.