Describe development version of Carpet and darcs

darcs-hash:20040928174706-891bb-50dcc63d6e6381b552d439d26de63d4409061de5.gz
author: Erik Schnetter <schnetter@aei.mpg.de> 2004-09-28 17:47:00 +0000
committer: Erik Schnetter <schnetter@aei.mpg.de> 2004-09-28 17:47:00 +0000
commit: f443b6bc8a88d52df45ac41572878604317687aa (patch)
tree: bac8f8cb0c668565e4c8a79c5df34192ced8b1c0 /Carpet/CarpetWeb
parent: c1c40a336147c0832d11e23edb05d64242505db8 (diff)
3 files changed, 290 insertions, 1 deletions
diff --git a/Carpet/CarpetWeb/get-carpet-darcs.html b/Carpet/CarpetWeb/get-carpet-darcs.html
new file mode 100644
index 000000000..5024068a8
--- /dev/null
+++ b/Carpet/CarpetWeb/get-carpet-darcs.html
@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="ISO-8859-15"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "DTD/xhtml1-transitional.dtd">
+<!-- $Header:$ -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15" />
+    <title>Getting the Development Version of Carpet</title>
+  </head>
+
+  <body>
+    <h1>Getting the Development Version of Carpet</h1>
+
+
+
+    <h2>About Darcs</h2>
+
+    <p>The development version of Carpet is now managed in a
+    <a href="http://abridgegame.org/darcs/">darcs</a> repository.  Darcs
+    has a number of advantages for us developers, such as:</p>
+
+    <ul>
+      <li>You have a local copy of the repository, and can therefore
+          work offline</li>
+      <li>You can decide which changes you want to import and export,
+          so that you can omit dangerous changes, or keep changes to
+          yourself until you are ready to publish them</li>
+      <li>You can undo most changes</li>
+      <li>You can easily rename files and directories</li>
+      <li>Darcs does not need its own server, which makes it both more
+          convenient and more secure</li>
+    </ul>
+
+    <p>and them some more, as described in the <a
+    href="http://abridgegame.org/darcs/manual/">darcs manual</a>.</p>
+
+
+
+    <h2>Getting Carpet</h2>
+
+    <p>In order to get the <a
+    href="http://www.carpetcode.org/~darcs/carpet/">development
+    version of Carpet</a>, you first need to install <tt>darcs</tt> on
+    your system.  This is described on the <a
+    href="http://abridgegame.org/darcs/">darcs home page</a>, and some
+    links to binaries are given in the darcs wiki.  If you have
+    problems installing or using darcs in general, then you should ask
+    on the darcs mailing list, which I (Erik Schnetter) also read
+    regularly.</p>
+
+    <p>After having installed <tt>darcs</tt>, take the following steps
+    to get Carpet:</p>
+
+    <ol>
+      <li>Move your old version of <tt>Carpet</tt> to a secure place:
+<pre>cd Cactus
+mkdir oldcarpet
+mv arrangements/Carpet* oldcarpet</pre></li>
+
+      <li>Get the development version of Carpet.  Carpet consists of
+          four arrangements that live in a single repository.  This
+          structure is not what Cactus expects, and we will therefore
+          put it outside the <tt>arrangements</tt> directory:
+<pre>cd Cactus
+darcs get http://www.carpetcode.org/~darcs/carpet</pre>
+          This copies the whole Carpet repository, and it will take some
+          time.</li>
+
+      <li>Create some symbolic links in the arrangements directory:
+<pre>cd Cactus/arrangements
+ln -s ../carpet/Carpet* .</pre>
+          (don't forget the dot at the end of the last line).</li>
+    </ol>
+
+    <p>That's it; you can now recompile your Cactus/Carpet
+    configurations.</p>
+
+
+
+    <h2>Updating Carpet</h2>
+
+    <p>At some time you will want to update your version of Carpet and
+    incorporate some changes from the main Carpet repository.</p>
+
+    <ol>
+      <li>You do this with the command
+<pre>cd Cactus/carpet
+darcs pull</pre>
+      which will look for new changes, and then ask you which of these
+      you want to obtain.  Normally, you will want all changes.</li>
+    </ol>
+
+
+
+    <h2>Working with Darcs</h2>
+
+    <p>We also have some instructions on how to <a
+    href="work-with-darcs.html">develop Carpet with darcs</a>.</p>
+
+
+
+
+    <hr />
+
+    <p>
+      <a href="http://validator.w3.org/check?uri=referer"><img
+          src="http://www.w3.org/Icons/valid-xhtml10"
+          alt="Valid XHTML 1.0!" height="31" width="88" /></a>
+    </p>
+
+    <hr />
+    <address><a href="mailto:schnetter@uni-tuebingen.de"></a></address>
+<!-- Created: Tue Sep 28 16:52:20 CEST 2004 -->
+<!-- hhmts start -->
+Last modified: Tue Sep 28 19:35:11 CEST 2004
+<!-- hhmts end -->
+  </body>
+</html>
diff --git a/Carpet/CarpetWeb/index.html b/Carpet/CarpetWeb/index.html
index 5f1e0d438..04ae976f0 100644
--- a/Carpet/CarpetWeb/index.html
+++ b/Carpet/CarpetWeb/index.html
@@ -62,7 +62,18 @@
 
     <h2>News</h2>
 
-    <p><b>August 24, 2004</b> The version of Carpet in the CVS
+    <p><b>Sepbember 18, 2004:</b> There is now a new repository for
+    the development version of Carpet.  This repository is managed by
+    <a href="http://abridgegame.org/darcs/">darcs</a> instead of <a
+    href="https://www.cvshome.org/">CVS</a>.  Darcs has a number of
+    advantages, such as being able to use it while offline, or keeping
+    some changes to yourself while developing.  This development
+    version is <a href="get-carpet-darcs.html">publicly available</a>,
+    and we encourage you to <a
+    href="work-with-darcs.html">contribute</a>.  Note that the stable
+    version of Carpet is still distributed via CVS.</p>
+
+    <p><b>August 24, 2004:</b> The version of Carpet in the CVS
     repository is now stable.  That means that this version will see
     no substantial further development.  One of its main goal is to
     not change, so that parameter files continue to work unchanged
diff --git a/Carpet/CarpetWeb/work-with-darcs.html b/Carpet/CarpetWeb/work-with-darcs.html
new file mode 100644
index 000000000..fc1a16911
--- /dev/null
+++ b/Carpet/CarpetWeb/work-with-darcs.html
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="ISO-8859-15"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "DTD/xhtml1-transitional.dtd">
+<!-- $Header:$ -->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15" />
+    <title>Using Darcs</title>
+  </head>
+
+  <body>
+    <h1>Using Darcs</h1>
+
+
+
+    <p>This text assumes that you have already installed <a
+    href="http://abridgegame.org/darcs/">darcs</a> and <a
+    href="get-carpet-darcs.html">obtained</a> the development version
+    of Carpet, but are possibly too scared or lazy to actually read
+    the <a href="http://abridgegame.org/darcs/manual/">darcs
+    manual</a>.</p>
+
+
+
+    <h2>Editing</h2>
+
+    <p>You edit the Carpet source code as usual.  At certain times you
+    can say</p>
+
+<pre>darcs whatsnew</pre>
+
+    <p>to find out what you changed.  As you have a copy of the Carpet
+    repository stored locally, this will not require an internet
+    connection and will be very fast.  One other difference from CVS
+    is that darcs always considers all changes in the repository, and
+    not just changes to a certain file or directory.</p>
+
+    <p>If you add or remove files or directories to the repository,
+    say</p>
+
+<pre>darcs add FILENAME</pre>
+
+    <p>or</p>
+
+<pre>darcs remove FILENAME</pre>
+
+    <p>This does not actually create or delete files; you have to do
+    that yourself.  If you move a file or directory, say</p>
+
+<pre>darcs mv FROM TO</pre>
+
+    <p>to tell darcs about that.  This does actually perform the move,
+    as indicated by the darcs command <tt>mv</tt>, which is spelled
+    the same way as the corresponding Unix command.</p>
+
+
+
+    <h2>Recording Changes</h2>
+
+    <p>If you have implemented a certain feature, corrected a certain
+    error, or fixed a typo, then it is time to record that change as a
+    patch.  The command</p>
+
+<pre>darcs record</pre>
+
+    <p>walks you through all your local changes and asks you whether
+    they should be part of the patch.  Please put only related changes
+    into a single patch; it is very easy to create multiple
+    patches.</p>
+
+    <p>Each patch needs a one-line description.  This description
+    should be somewhat descriptive, because other people will decide
+    from this description whether they want this patch or not.
+    "<i>Correct error</i>" will probably not be very helpful, as won't
+    "<i>Use cout instead of printf</i>", because these descriptions do
+    not describe what part of Carpet is actually changed.  On the
+    other hand, "<i>Fix typo in comment</i>" is probably good enough.
+    If you feel like it, you can also add a detailed description of
+    the patch.  Note that this description should describe the patch,
+    and should not describe how to use a certain feature; this should
+    go into a comment or a README or the documentation.</p>
+
+    <p>If you later discover that your patch is incomplete, missing a
+    file, or contains an error, then you can use</p>
+
+<pre>darcs rerecord</pre>
+
+    <p>to correct it.  It is often better to correct an erroneous
+    patch than to pile a second patch on top of it.  If you think that
+    things are very wrong, then</p>
+
+<pre>darcs unrecord</pre>
+
+    <p>deletes the patch entirely.  None of the above commands change
+    your working directory.</p>
+
+
+
+    <h2>Contributing Patches</h2>
+
+    <p>When you have one or a few patches that you would like to
+    contribute back to the community, then you can use</p>
+
+<pre>darcs send</pre>
+
+    <p>to send these to the Carpet mailing list.  The Carpet
+    maintainers can then apply this patch to the Carpet repository, so
+    that the next <tt>darcs pull</tt> will list this patch for all
+    people.  <tt>darcs send</tt> is the first command described on
+    this page that actually needs network access.</p>
+
+
+
+    <h2>Correcting Errors</h2>
+
+    <p>Darcs offers a host of commands to undo various actions.</p>
+
+<pre>darcs unrecord</pre>
+
+     <p>was already described above.</p>
+
+<pre>darcs unpull</pre>
+
+     <p>undoes the effect of pulling a patch from a remote repository.
+     This is useful if you suspect that this patch introduced an
+     error.  And</p>
+
+<pre>darcs revert</pre>
+
+     <p>undoes changes to your working directory that have not yet
+     been recorded.</p>
+
+
+
+     <h2>Further Information</h2>
+
+     <p>As usual, the authoritative source of information is the <a
+     href="http://abridgegame.org/darcs/manual/">darcs manual</a>,
+     which also ships with your darcs installation.</p>
+
+
+
+    <hr />
+
+    <p>
+      <a href="http://validator.w3.org/check?uri=referer"><img
+          src="http://www.w3.org/Icons/valid-xhtml10"
+          alt="Valid XHTML 1.0!" height="31" width="88" /></a>
+    </p>
+
+    <hr />
+    <address><a href="mailto:schnetter@uni-tuebingen.de"></a></address>
+<!-- Created: Tue Sep 28 16:52:20 CEST 2004 -->
+<!-- hhmts start -->
+Last modified: Tue Sep 28 19:43:36 CEST 2004
+<!-- hhmts end -->
+  </body>
+</html>
author	Erik Schnetter <schnetter@aei.mpg.de>	2004-09-28 17:47:00 +0000
committer	Erik Schnetter <schnetter@aei.mpg.de>	2004-09-28 17:47:00 +0000
commit	f443b6bc8a88d52df45ac41572878604317687aa (patch)
tree	bac8f8cb0c668565e4c8a79c5df34192ced8b1c0 /Carpet/CarpetWeb
parent	c1c40a336147c0832d11e23edb05d64242505db8 (diff)