Jason Harris avatar Jason Harris committed 9946535

Update documentation

Comments (0)

Files changed (1)

-== Ban Changesets ==
+== HGBAN ==
 
 A mercurial extension to ban specific changesets from a repository.
 
 The ban-changesets extension is enabled just like other mercurial extensions. Ie add something like the following to your {{{~/.hgrc}}} file:
 {{{
 [extensions]
-ban-changesets = /path/to/ban-changesets.py
+hgban = /path/to/hgban.py
 }}}
 
-=== Format of the .hgbanneddchangesets file ===
+=== Format of the .hgban file ===
 
-The {{{.hgbanneddchangesets}}} file is examined line by line by the ban-changesets extension. The changeset hash should start at the very beginning of the line and anything else on the line is ignored. (In fact if you understand regular expressions each line is matched by "{{{(^[0-9a-fA-F]+).*}}}" and the changeset hash is taken to be {{{\1}}})
+The {{{.hgban}}} file is examined line by line by the ban-changesets extension. The changeset hash should start at the very beginning of the line. (Actually you can use general reveset syntax to specify multiple criterion for banning changesets.)
 
-Thus the following is a valid {{{.hgbanneddchangeset}}} file:
+Thus the following is a valid {{{.hgban}}} file:
 {{{
 # Ignore these changesets due to bad branch merge
 162a93e027fdcc6f037c80d185eb201e346da0b0
 69cc2b0e47158d1a571a35ec89c5524b084944c9
 
 # Ignore this changeset because it contains the nuclear launch code that Billy included
-a4988662d998b8d986bdaec43079475827aa31d0 # The "launch" code commit
+a4988662d998b8d986bdaec43079475827aa31d0
 }}}
 
 === What does a user do if changesets are rejected ===
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.