35e941dc16cb

Update the documentation to mention pjv's tasks keyword.

fixes issue 4
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Thu, 23 Jul 2009 01:50:06 -0400
parents c2f93120c221
children 07e1b5f8e641
branches/tags (none)
files README prompt.py

Changes

--- a/README	Thu Jul 23 01:49:21 2009 -0400
+++ b/README	Thu Jul 23 01:50:06 2009 -0400
@@ -57,11 +57,15 @@
 
 There are only a few keywords at the moment (mostly the ones I want for myself).  If you have any suggestions for more please let me know.
 
-* **bookmark:** the current bookmark
+* **bookmark:** the current bookmark (requires the [bookmarks]() extension)
 * **branch:** the current branch
 * **root:** the full path to the root of the current repository, without a trailing slash
 * **root|basename:** the directory name of the root of the current repository.  For example, if the repository is in `/home/u/myrepo` then this keyword would expand to `myrepo`.
 * **status:**  `!` if the repository has any changed/added/removed files, otherwise `?` if it has any untracked (but not ignored) files, otherwise nothing.
+* **task:** the current task (requires the [tasks]() extension)
+
+[bookmarks]: http://mercurial.selenic.com/wiki/BookmarksExtension
+[tasks]: http://bitbucket.org/alu/hgtasks/wiki/Home
 
 Remote Status Keywords
 ----------------------
--- a/prompt.py	Thu Jul 23 01:49:21 2009 -0400
+++ b/prompt.py	Thu Jul 23 01:50:06 2009 -0400
@@ -64,7 +64,7 @@
     
     The following keywords are available:
     
-    - bookmark: the current bookmark
+    - bookmark: the current bookmark (requires the bookmarks extension)
     - branch: the current branch
     - root: the full path to the root of the current repository, without a 
         trailing slash
@@ -74,6 +74,7 @@
     - status: "!" if the current repository contains files that have been
         modified, added, removed, or deleted, otherwise "?" if it contains
         untracked (and not ignored) files, otherwise nothing.
+    - task: the current task (requires the tasks extension)
     
     There are also several keywords that deal with the status of remote
     repositories.  They cache their results in .hg/prompt/cache/ and refresh