mirror of
https://github.com/GrammaticalFramework/gf-core.git
synced 2026-04-09 13:09:33 -06:00
418 lines
13 KiB
HTML
418 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="generator" CONTENT="http://txt2tags.sf.net">
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
|
|
<TITLE>GF Darcs repository</TITLE>
|
|
</HEAD><BODY BGCOLOR="white" TEXT="black">
|
|
<P ALIGN="center"><CENTER><H1>GF Darcs repository</H1>
|
|
<FONT SIZE="4">
|
|
<I>Author: Björn Bringert <bringert@cs.chalmers.se></I><BR>
|
|
Last update: Wed Oct 3 15:13:24 2007
|
|
</FONT></CENTER>
|
|
|
|
<P></P>
|
|
<HR NOSHADE SIZE=1>
|
|
<P></P>
|
|
<UL>
|
|
<LI><A HREF="#toc1">What is darcs?</A>
|
|
<LI><A HREF="#toc2">How do I install Darcs?</A>
|
|
<LI><A HREF="#toc3">Read-only access</A>
|
|
<UL>
|
|
<LI><A HREF="#toc4">Getting a fresh copy for read-only access</A>
|
|
<LI><A HREF="#toc5">Updating your copy</A>
|
|
<LI><A HREF="#toc6">Recording local changes</A>
|
|
<LI><A HREF="#toc7">Submitting patches</A>
|
|
</UL>
|
|
<LI><A HREF="#toc8">Read-write access</A>
|
|
<UL>
|
|
<LI><A HREF="#toc9">Setting up your $PATH on the Chalmers system</A>
|
|
<LI><A HREF="#toc10">Getting a fresh copy</A>
|
|
<LI><A HREF="#toc11">Getting other people's changes?</A>
|
|
<LI><A HREF="#toc12">Commit your changes</A>
|
|
<LI><A HREF="#toc13">Apply a patch from someone else</A>
|
|
</UL>
|
|
<LI><A HREF="#toc14">Troubleshooting</A>
|
|
<UL>
|
|
<LI><A HREF="#toc15">I get the error "darcs not found" when pushing</A>
|
|
<LI><A HREF="#toc16">I get the error "(sftp) failed to fetch files."</A>
|
|
<LI><A HREF="#toc17">How do I avoid typing in my password so many times?</A>
|
|
<UL>
|
|
<LI><A HREF="#toc18">Using ssh ControlMaster</A>
|
|
<LI><A HREF="#toc19">Using ssh-agent</A>
|
|
</UL>
|
|
</UL>
|
|
<LI><A HREF="#toc20">Technical Information</A>
|
|
<LI><A HREF="#toc21">Further information about Darcs</A>
|
|
</UL>
|
|
|
|
<P></P>
|
|
<HR NOSHADE SIZE=1>
|
|
<P></P>
|
|
<P>
|
|
<B>GF has now been moved to a Darcs repository. No changes should be committed to the CVS repository from now on.</B>
|
|
</P>
|
|
<A NAME="toc1"></A>
|
|
<H1>What is darcs?</H1>
|
|
<P>
|
|
Darcs is a decentralized revision control system. These are some of
|
|
the reasons for switching GF from CVS to Darcs:
|
|
</P>
|
|
<UL>
|
|
<LI>You can keep local revision control in your checked-out copy, since
|
|
each checked-out copy is a repository in itself. For example, this
|
|
allows the WebALT project to keep a local GF repository for working
|
|
on the resource grammars, and submit patches to the main repo when
|
|
that is convenient. It also allows individual developers to keep
|
|
revision control over their own modifications before they are ready
|
|
to submit them, or if they are temporarily without net access.
|
|
<P></P>
|
|
<LI>We can provide read-only access over HTTP using the existing CS web server.
|
|
<P></P>
|
|
<LI>It is possible and easy to rename and remove both files and directories.
|
|
</UL>
|
|
|
|
<P>
|
|
For more information about Darcs, see <A HREF="http://darcs.net/">http://darcs.net/</A>.
|
|
</P>
|
|
<A NAME="toc2"></A>
|
|
<H1>How do I install Darcs?</H1>
|
|
<P>
|
|
There are precompiled packages for many platforms available at
|
|
<A HREF="http://darcs.net/DarcsWiki/CategoryBinaries">http://darcs.net/DarcsWiki/CategoryBinaries</A>.
|
|
</P>
|
|
<P>
|
|
There is also source code if you want to compile it yourself. Darcs is
|
|
written in Haskell and you need GHC to compile it.
|
|
</P>
|
|
<A NAME="toc3"></A>
|
|
<H1>Read-only access</H1>
|
|
<A NAME="toc4"></A>
|
|
<H2>Getting a fresh copy for read-only access</H2>
|
|
<P>
|
|
Anyone can get the latest development version of GF by running (all on one line):
|
|
</P>
|
|
<PRE>
|
|
$ darcs get --partial --set-scripts-executable http://www.cs.chalmers.se/Cs/Research/Language-technology/darcs/GF/
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
This will create a directory called <CODE>GF</CODE> in the current
|
|
directory. See <CODE>GF/src/INSTALL</CODE> for instructions on compiling. The
|
|
main difference compared to compiling a GF release is that you
|
|
need to run <CODE>autoconf</CODE> before <CODE>./configure</CODE>.
|
|
</P>
|
|
<A NAME="toc5"></A>
|
|
<H2>Updating your copy</H2>
|
|
<P>
|
|
To get all new patches from the main repo:
|
|
</P>
|
|
<PRE>
|
|
$ darcs pull -a
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
This can be done anywhere in your local repository, i.e. in the <CODE>GF</CODE>
|
|
directory, or any of its subdirectories.
|
|
</P>
|
|
<P>
|
|
Without <CODE>-a</CODE>, you can choose which patches you want to get.
|
|
</P>
|
|
<A NAME="toc6"></A>
|
|
<H2>Recording local changes</H2>
|
|
<P>
|
|
Since every copy is a repository, you can have local version control
|
|
of your changes.
|
|
</P>
|
|
<P>
|
|
If you have added files, you first need to tell your local repository to
|
|
keep them under revision control:
|
|
</P>
|
|
<PRE>
|
|
$ darcs add file1 file2 ...
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
To record changes, use:
|
|
</P>
|
|
<PRE>
|
|
$ darcs record
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
This creates a patch against the previous version and stores it in your
|
|
local repository. You can record any number of changesets before
|
|
pushing them to the main repo. In fact, you don't have to push them at
|
|
all if you want to keep the changes only in your local repo.
|
|
</P>
|
|
<P>
|
|
If you think there are too many questions about what to record, you
|
|
can use the <CODE>-a</CODE> flag to <CODE>record</CODE>. Or answer <CODE>a</CODE> to the first
|
|
question. Both of these record all the changes you have in your local
|
|
repository.
|
|
</P>
|
|
<A NAME="toc7"></A>
|
|
<H2>Submitting patches</H2>
|
|
<P>
|
|
If you are using read-only access, send your patches by email to
|
|
someone with write-access. First record your changes in your local
|
|
repository, as described above. You can send any number of recorded
|
|
patches as one patch bundle. You create the patch bundle with:
|
|
</P>
|
|
<PRE>
|
|
$ darcs send -o mypatch.patch
|
|
$ gzip mypatch.patch
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
(where <CODE>mypatch</CODE> is hopefully replaced by a slightly more
|
|
descriptive name). Since some e-mail setups change text attachments
|
|
(most likely by changing the newline characters) you need to send
|
|
the patch in some compressed format, such as GZIP, BZIP2 or ZIP.
|
|
</P>
|
|
<P>
|
|
Send it as an e-mail attachment. If you have
|
|
sendmail or something equivalent installed, it is possible to send the
|
|
patch directly from darcs. If so, replace <CODE>-o mypatch.patch</CODE> with
|
|
<CODE>--to=EMAIL</CODE> where <CODE>EMAIL</CODE> is the address to send it to.
|
|
</P>
|
|
<A NAME="toc8"></A>
|
|
<H1>Read-write access</H1>
|
|
<P>
|
|
If you have an account on the Chalmers system and want read-write
|
|
access, you can access the repository using ssh.
|
|
You need to be a member of the <CODE>langtech</CODE> group to push changes to
|
|
the repository.
|
|
</P>
|
|
<P>
|
|
If darcs seems to ask for your <B>password multiple times</B> for a single
|
|
push or pull, try upgrading to recent versions of darcs and OpenSSH
|
|
(OpenSSH version 4 or newer).
|
|
Recent OpenSSH versions include a connection multiplexing feature, which
|
|
recent darcs versions support.
|
|
Note that darcs 1.0.9 has some problems with this, try downgrading
|
|
to darcs 1.0.8.
|
|
</P>
|
|
<P>
|
|
<B>Note: we seem to have some problems getting read-write access working smoothly on Windows.</B>
|
|
If you figure out how to do this, let us know. If not, you can still use read-only access,
|
|
record patches in your local repository, and send them by e-mail once in a while.
|
|
</P>
|
|
<A NAME="toc9"></A>
|
|
<H2>Setting up your $PATH on the Chalmers system</H2>
|
|
<P>
|
|
The <CODE>darcs</CODE> program has to be on your <CODE>$PATH</CODE> on the Chalmers
|
|
system to make it possible for you to push changes to the main
|
|
repository. To fix this, log in to your Chalmers account and run:
|
|
</P>
|
|
<PRE>
|
|
mkdir -p $HOME/.vcs4
|
|
echo unsup >> $HOME/.vcs4/pathsetup
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
Note that the path setup works differently on different Chalmers machines.
|
|
The command above will setup you path on the newer machines correctly.
|
|
</P>
|
|
<A NAME="toc10"></A>
|
|
<H2>Getting a fresh copy</H2>
|
|
<P>
|
|
Get your copy with (all on one line),
|
|
replacing <CODE>bringert</CODE> with your own username on the
|
|
Chalmers system:
|
|
</P>
|
|
<PRE>
|
|
$ darcs get --partial --set-scripts-executable bringert@momo.medic.chalmers.se:/users/cs/www/Research/Language-technology/darcs/GF/
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
Note that <B>you really need to use <CODE>momo.medic.chalmers.se</CODE></B>
|
|
(or some other server with the new Linux system) since we need to
|
|
have a server with at least Darcs 1.0.4. If you use some server
|
|
with an earlier Darcs version you can mess up the repository.
|
|
</P>
|
|
<P>
|
|
The option <CODE>--partial</CODE> means that you do not download all of the
|
|
history for the repository. This saves space, bandwidth and CPU time,
|
|
and most people don't need the full history of all changes in the
|
|
past.
|
|
</P>
|
|
<A NAME="toc11"></A>
|
|
<H2>Getting other people's changes?</H2>
|
|
<P>
|
|
Get all new patches from the main repo:
|
|
</P>
|
|
<PRE>
|
|
$ darcs pull -a
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
Without <CODE>-a</CODE>, you can choose which patches you want to get.
|
|
</P>
|
|
<A NAME="toc12"></A>
|
|
<H2>Commit your changes</H2>
|
|
<P>
|
|
There are two steps to commiting a change to the main repo. First you
|
|
have to record the changes that you want to commit, then you push them
|
|
to the main repo.
|
|
</P>
|
|
<P>
|
|
For instructions on recording your changes locally,
|
|
see "Recording local changes" above.
|
|
</P>
|
|
<P>
|
|
Then you can push the patch(es) to the main repo. If you are using
|
|
ssh-access, all you need to do is:
|
|
</P>
|
|
<PRE>
|
|
$ darcs push
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
If you use the <CODE>-a</CODE> flag to push, all local patches which are not in
|
|
the main repo are pushed.
|
|
</P>
|
|
<A NAME="toc13"></A>
|
|
<H2>Apply a patch from someone else</H2>
|
|
<P>
|
|
Use:
|
|
</P>
|
|
<PRE>
|
|
$ darcs apply < mypatch.patch
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
This applies the patch to your local repository. To commit it to the
|
|
main repo, use <CODE>darcs push</CODE>.
|
|
</P>
|
|
<A NAME="toc14"></A>
|
|
<H1>Troubleshooting</H1>
|
|
<A NAME="toc15"></A>
|
|
<H2>I get the error "darcs not found" when pushing</H2>
|
|
<P>
|
|
If you get <CODE>darcs not found</CODE> when you try to push your changes, you
|
|
don't have darcs on your <CODE>$PATH</CODE> on the Chalmers system. See
|
|
the section above on setting up your <CODE>$PATH</CODE> on the Chalmers system.
|
|
</P>
|
|
<A NAME="toc16"></A>
|
|
<H2>I get the error "(sftp) failed to fetch files."</H2>
|
|
<P>
|
|
There seems to be a problem with how darcs 1.0.4 calls sftp, which
|
|
means that normal password authentication does not work.
|
|
Try upgrading to a more recent version of darcs.
|
|
</P>
|
|
<A NAME="toc17"></A>
|
|
<H2>How do I avoid typing in my password so many times?</H2>
|
|
<A NAME="toc18"></A>
|
|
<H3>Using ssh ControlMaster</H3>
|
|
<P>
|
|
Get a recent darcs and OpenSSH, see above.
|
|
</P>
|
|
<P>
|
|
Note that the ControlMaster feature does not seem to
|
|
work properly in darcs 1.0.9 under Mac OS X.
|
|
Use darcs 1.0.8 instead.
|
|
</P>
|
|
<A NAME="toc19"></A>
|
|
<H3>Using ssh-agent</H3>
|
|
<P>
|
|
<B>NOTE: the method below will not work with <CODE>momo.medic.chalmers.se</CODE></B>.
|
|
MEDIC has decided to disable public key authentication on all new machines.
|
|
This section is included just for reference in case they decide to enable
|
|
it again.
|
|
</P>
|
|
<P>
|
|
With the ssh access method, Darcs needs to log in with ssh. For some
|
|
reason it needs to do this several times for each operation. You can
|
|
avoid this by setting up public-key authentication for ssh.
|
|
</P>
|
|
<P>
|
|
Here is a guide to setting this up:
|
|
<A HREF="http://cfm.gs.washington.edu/security/ssh/client-pkauth/">http://cfm.gs.washington.edu/security/ssh/client-pkauth/</A>
|
|
</P>
|
|
<P>
|
|
Short summary (should on most modern Linux distros, maybe other
|
|
platforms too):
|
|
</P>
|
|
<P>
|
|
Generate a key pair:
|
|
</P>
|
|
<PRE>
|
|
$ mkdir -p ~/.ssh
|
|
$ chmod 700 ~/.ssh
|
|
$ ssh-keygen -q -f ~/.ssh/id_rsa -t rsa
|
|
Enter passphrase (empty for no passphrase): ...
|
|
Enter same passphrase again: ...
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
Upload the public key to your Chalmers account (replace <CODE>bringert</CODE> with
|
|
your username):
|
|
</P>
|
|
<PRE>
|
|
$ ssh-copy-id -i ~/.ssh/id_rsa.pub bringert@remote.cs.chalmers.se
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
Add the key to ssh-agent (ssh-agent then remembers your key for a
|
|
while, so that you don't have to type in the passphrase again):
|
|
</P>
|
|
<PRE>
|
|
$ ssh-add
|
|
Enter passphrase for /home/bjorn/.ssh/id_rsa: ...
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
This is the part that is most likely to fail. If ssh-add says that it
|
|
couldn't find ssh-agent, you need to follow the instructions linked to
|
|
above to start ssh-agent.
|
|
</P>
|
|
<P>
|
|
Try to use it to log in (with your own username again):
|
|
</P>
|
|
<PRE>
|
|
$ ssh bringert@remote.cs.chalmers.se
|
|
...
|
|
zsh:bringert:[~]>
|
|
</PRE>
|
|
<P></P>
|
|
<A NAME="toc20"></A>
|
|
<H1>Technical Information</H1>
|
|
<P>
|
|
This section contains information about how the repository is set
|
|
up. It might be useful for troubleshooting the repository setup
|
|
or creating a similiar setup for another repository.
|
|
</P>
|
|
<P>
|
|
The main repository is in
|
|
<CODE>/users/cs/www/Research/Language-technology/darcs/GF</CODE>, which is
|
|
visible to the web server. The repository and all files and
|
|
directories in it group writable, owned by the group <CODE>langtech</CODE>, and
|
|
all directories have the setgid bit set:
|
|
</P>
|
|
<PRE>
|
|
drwxrwsr-x 10 bringert langtech 512 Nov 17 19:00 /users/cs/www/Research/Language-technology/darcs/GF
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
The repo has this in <CODE>_darcs/prefs/defaults</CODE>:
|
|
</P>
|
|
<PRE>
|
|
apply posthook find . -user "$USER" -a ! -perm +g+w -exec chmod g+w '{}' ';'
|
|
apply run-posthook
|
|
</PRE>
|
|
<P></P>
|
|
<P>
|
|
The server which we push to has darcs 1.0.4, which is needed for
|
|
posthook support.
|
|
</P>
|
|
<A NAME="toc21"></A>
|
|
<H1>Further information about Darcs</H1>
|
|
<P>
|
|
For more info about what you can do with darcs, see <A HREF="http://darcs.net/manual/">http://darcs.net/manual/</A>
|
|
</P>
|
|
|
|
<!-- html code generated by txt2tags 2.4 (http://txt2tags.sf.net) -->
|
|
<!-- cmdline: txt2tags darcs.txt -->
|
|
</BODY></HTML>
|