From: W. Trevor King Date: Sat, 26 Jun 2010 19:21:46 +0000 (-0400) Subject: Updated docs b/c of new Monotone backend X-Git-Tag: 1.0.0~33 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=17a8f2262069e2f68a595a84dd9f705bff2b2276;p=be.git Updated docs b/c of new Monotone backend --- diff --git a/README b/README index e916414..82f52c8 100644 --- a/README +++ b/README @@ -2,9 +2,9 @@ Bugs Everywhere =============== This is Bugs Everywhere (BE), a bugtracker built on distributed version -control. It works with Arch, Bazaar, Darcs, Git, and Mercurial at the -moment, but is easily extensible. It can also function with no VCS at -all. +control. It works with Arch, Bazaar, Darcs, Git, Mercurial, and Monotone +at the moment, but is easily extensible. It can also function with no +VCS at all. The idea is to package the bug information with the source code, so that bugs can be marked "fixed" in the branches that fix them. So, instead of diff --git a/doc/index.txt b/doc/index.txt index 77e756e..fdf6e02 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -2,15 +2,16 @@ Welcome to the bugs-everywhere documentation! ============================================= Bugs Everywhere (BE) is a bugtracker built on distributed version -control. It works with Arch_, Bazaar_, Darcs_, Git_, and Mercurial_ -at the moment, but is easily extensible. It can also function with no -VCS at all. +control. It works with Arch_, Bazaar_, Darcs_, Git_, Mercurial_, and +Monotone_ at the moment, but is easily extensible. It can also +function with no VCS at all. .. _Arch: http://www.gnu.org/software/gnu-arch/ .. _Bazaar: http://bazaar.canonical.com/ .. _Darcs: http://darcs.net/ .. _Git: http://git-scm.com/ .. _Mercurial: http://mercurial.selenic.com/ +.. _Monotone: http://www.monotone.ca/ The idea is to package the bug information with the source code, so that bugs can be marked "fixed" in the branches that fix them. diff --git a/doc/spam.txt b/doc/spam.txt index 39e7a86..1e869fb 100644 --- a/doc/spam.txt +++ b/doc/spam.txt @@ -10,17 +10,19 @@ through you interface, you can (sometimes) remove the offending commit If the offending commit is the last commit ========================================== -+-------+----------------------------+ -| arch | | -+-------+----------------------------+ -| bzr | bzr uncommit && bzr revert | -+-------+----------------------------+ -| darcs | darcs obliterate --last=1 | -+-------+----------------------------+ -| git | git reset --hard HEAD^ | -+-------+----------------------------+ -| hg | hg rollback && hg revert | -+-------+----------------------------+ ++-------+--------------------------------------------------------------+ +| arch | | ++-------+--------------------------------------------------------------+ +| bzr | bzr uncommit && bzr revert | ++-------+--------------------------------------------------------------+ +| darcs | darcs obliterate --last=1 | ++-------+--------------------------------------------------------------+ +| git | git reset --hard HEAD^ | ++-------+--------------------------------------------------------------+ +| hg | hg rollback && hg revert | ++-------+--------------------------------------------------------------+ +| mtn | mnt db kill_rev_locally $(mnt automate get_base_revision_id) | ++-------+--------------------------------------------------------------+ If the offending commit is not the last commit ============================================== @@ -36,20 +38,26 @@ If the offending commit is not the last commit +----------+-----------------------------------------------+ | hg [#]_ | | +----------+-----------------------------------------------+ +| mtn [#]_ | | ++----------+-----------------------------------------------+ .. [#] Requires the ```bzr-rebase`` plugin`_. Note, you have to increment ``XYZ`` by hand for ````, because ``bzr`` does not support ``after:XYZ``. -.. [#] From `Mercurial: The Definitive Guide`: +.. [#] From `Mercurial: The Definitive Guide`_: "Mercurial also does not provide a way to make a file or changeset completely disappear from history, because there is no way to enforce its disappearance" +.. [#] See `Rebuilding ancestry`_ in the Monotone documentation. + .. _bzr-rebase plugin: http://wiki.bazaar.canonical.com/Rebase .. _Mercurial: The Definitive Guide: http://hgbook.red-bean.com/read/finding-and-fixing-mistakes.html#id394667 +.. _Rebuilding ancestry: + http://www.monotone.ca/docs/Rebuilding-ancestry.html Warnings about changing history =============================== diff --git a/doc/tutorial.txt b/doc/tutorial.txt index 592aef5..0da1de2 100644 --- a/doc/tutorial.txt +++ b/doc/tutorial.txt @@ -74,11 +74,11 @@ Initialization -------------- You're happily coding in your Arch_ / Bazaar_ / Darcs_ / Git_ / -Mercurial_ versioned project and you discover a bug. "Hmm, I'll need -a simple way to track these things", you think. This is where BE -comes in. One of the benefits of distributed versioning systems is -the ease of repository creation, and BE follows this trend. Just -type:: +Mercurial_ / Monotone_ versioned project and you discover a bug. +"Hmm, I'll need a simple way to track these things", you think. This +is where BE comes in. One of the benefits of distributed versioning +systems is the ease of repository creation, and BE follows this trend. +Just type:: $ be init Using for revision control. @@ -98,6 +98,7 @@ if you call it from a directory besides your project's root. .. _Darcs: http://darcs.net/ .. _Git: http://git-scm.com/ .. _Mercurial: http://mercurial.selenic.com/ +.. _Monotone: http://www.monotone.ca/ Inside the ``.be`` directory (among other things) there will be a long UUID_ directory. This is your bug directory. The idea is that you