mirror of
https://github.com/GrammaticalFramework/gf-core.git
synced 2026-04-22 19:22:50 -06:00
Developer documentation updates prompted by the switch to darcs version 2
In particular, the --lazy flag replaces the --partial flag.
This commit is contained in:
@@ -8,7 +8,7 @@
|
|||||||
<P ALIGN="center"><CENTER><H1>GF Developers Guide</H1>
|
<P ALIGN="center"><CENTER><H1>GF Developers Guide</H1>
|
||||||
<FONT SIZE="4">
|
<FONT SIZE="4">
|
||||||
<I>Authors: Björn Bringert and Krasimir Angelov</I><BR>
|
<I>Authors: Björn Bringert and Krasimir Angelov</I><BR>
|
||||||
Last update: Fri Jun 19 15:27:27 2009
|
Last update: Mon Dec 14 18:55:45 2009
|
||||||
</FONT></CENTER>
|
</FONT></CENTER>
|
||||||
|
|
||||||
<P></P>
|
<P></P>
|
||||||
@@ -101,14 +101,14 @@ in the following order:
|
|||||||
|
|
||||||
<P>
|
<P>
|
||||||
the first that is found will be used in the compilation. The libraries are also written
|
the first that is found will be used in the compilation. The libraries are also written
|
||||||
in Haskell and could be found on Hackage: <A HREF="http://hackage.haskell.org/">http://hackage.haskell.org/packages/archive/pkg-list.html</A>. If you want to check whether,
|
in Haskell and could be found on Hackage: <A HREF="http://hackage.haskell.org/packages/archive/pkg-list.html">http://hackage.haskell.org/packages/archive/pkg-list.html</A>. If you want to check whether,
|
||||||
you already have some of these you can use the following command:
|
you already have some of these you can use the following command:
|
||||||
</P>
|
</P>
|
||||||
<PRE>
|
<PRE>
|
||||||
$ ghc-pkg list
|
$ ghc-pkg list
|
||||||
</PRE>
|
</PRE>
|
||||||
<P>
|
<P>
|
||||||
which shows the list of all installed libraries.
|
which shows the list of all installed libraries.
|
||||||
</P>
|
</P>
|
||||||
<P>
|
<P>
|
||||||
Haskeline is the easiest to install because it is a pure Haskell library but currently
|
Haskeline is the easiest to install because it is a pure Haskell library but currently
|
||||||
@@ -120,8 +120,9 @@ if you tend to work on non-Latin language. Finaly readline supports both word co
|
|||||||
and Unicode. Currently this is the best supported library.
|
and Unicode. Currently this is the best supported library.
|
||||||
</P>
|
</P>
|
||||||
<P>
|
<P>
|
||||||
Before to get the GF sources you also need Darcs. Darcs is a decentralized revision control system,
|
Before to get the GF sources you also need Darcs, version 2 or later.
|
||||||
see: <A HREF="http://darcs.net/">http://darcs.net/</A> for more information. There are precompiled packages for many platforms available at
|
Darcs is a decentralized revision control system,
|
||||||
|
see <A HREF="http://darcs.net/">http://darcs.net/</A> for more information. There are precompiled packages for many platforms available at
|
||||||
<A HREF="http://darcs.net/DarcsWiki/CategoryBinaries">http://darcs.net/DarcsWiki/CategoryBinaries</A>. There is also source code if you want to compile it yourself. Darcs is
|
<A HREF="http://darcs.net/DarcsWiki/CategoryBinaries">http://darcs.net/DarcsWiki/CategoryBinaries</A>. There is also source code if you want to compile it yourself. Darcs is
|
||||||
also written in Haskell and so you can use GHC to compile it.
|
also written in Haskell and so you can use GHC to compile it.
|
||||||
</P>
|
</P>
|
||||||
@@ -141,7 +142,7 @@ If you plan to work continuously on GF then you should consider to get read-writ
|
|||||||
Anyone can get the latest development version of GF by running (all on one line):
|
Anyone can get the latest development version of GF by running (all on one line):
|
||||||
</P>
|
</P>
|
||||||
<PRE>
|
<PRE>
|
||||||
$ darcs get --partial --set-scripts-executable http://code.haskell.org/gf/
|
$ darcs get --lazy --set-scripts-executable http://code.haskell.org/gf/
|
||||||
</PRE>
|
</PRE>
|
||||||
<P></P>
|
<P></P>
|
||||||
<P>
|
<P>
|
||||||
@@ -168,7 +169,7 @@ Since every copy is a repository, you can have local version control
|
|||||||
of your changes.
|
of your changes.
|
||||||
</P>
|
</P>
|
||||||
<P>
|
<P>
|
||||||
If you have added files, you first need to tell your local repository to
|
If you have added files, you first need to tell your local repository to
|
||||||
keep them under revision control:
|
keep them under revision control:
|
||||||
</P>
|
</P>
|
||||||
<PRE>
|
<PRE>
|
||||||
@@ -198,7 +199,7 @@ repository.
|
|||||||
<H3>Submitting patches</H3>
|
<H3>Submitting patches</H3>
|
||||||
<P>
|
<P>
|
||||||
If you are using read-only access, send your patches by email to
|
If you are using read-only access, send your patches by email to
|
||||||
someone with write-access. First record your changes in your local
|
someone with write-access. First record your changes in your local
|
||||||
repository, as described above. You can send any number of recorded
|
repository, as described above. You can send any number of recorded
|
||||||
patches as one patch bundle. You create the patch bundle with:
|
patches as one patch bundle. You create the patch bundle with:
|
||||||
</P>
|
</P>
|
||||||
@@ -223,7 +224,7 @@ patch directly from darcs. If so, replace <CODE>-o mypatch.patch</CODE> with
|
|||||||
<H2>Read-write access</H2>
|
<H2>Read-write access</H2>
|
||||||
<P>
|
<P>
|
||||||
If you have a user account on code.haskell.org, you can get read-write access over SSH
|
If you have a user account on code.haskell.org, you can get read-write access over SSH
|
||||||
to the GF repository.
|
to the GF repository.
|
||||||
To get an account, <A HREF="http://community.haskell.org/admin/account_request.html">fill out this form</A>.
|
To get an account, <A HREF="http://community.haskell.org/admin/account_request.html">fill out this form</A>.
|
||||||
Once you have an account, ask <<A HREF="mailto:aarne@chalmers.se">aarne@chalmers.se</A>> to add you to the <CODE>GF</CODE> project.
|
Once you have an account, ask <<A HREF="mailto:aarne@chalmers.se">aarne@chalmers.se</A>> to add you to the <CODE>GF</CODE> project.
|
||||||
</P>
|
</P>
|
||||||
@@ -234,11 +235,11 @@ Get your copy with (all on one line),
|
|||||||
replacing <CODE>bringert</CODE> with your own username on code.haskell.org:
|
replacing <CODE>bringert</CODE> with your own username on code.haskell.org:
|
||||||
</P>
|
</P>
|
||||||
<PRE>
|
<PRE>
|
||||||
$ darcs get --partial --set-scripts-executable bringert@code.haskell.org:/srv/code/gf
|
$ darcs get --lazy --set-scripts-executable bringert@code.haskell.org:/srv/code/gf
|
||||||
</PRE>
|
</PRE>
|
||||||
<P></P>
|
<P></P>
|
||||||
<P>
|
<P>
|
||||||
The option <CODE>--partial</CODE> means that you do not download all of the
|
The option <CODE>--lazy</CODE> means that darcs defers downloading all the
|
||||||
history for the repository. This saves space, bandwidth and CPU time,
|
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
|
and most people don't need the full history of all changes in the
|
||||||
past.
|
past.
|
||||||
@@ -261,7 +262,7 @@ Without <CODE>-a</CODE>, you can choose which patches you want to get.
|
|||||||
There are two steps to commiting a change to the main repo. First you
|
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
|
have to record the changes that you want to commit, then you push them
|
||||||
to the main repo. For instructions on recording your changes locally,
|
to the main repo. For instructions on recording your changes locally,
|
||||||
see "Recording local changes" above. Then you can push the patch(es) to
|
see "Recording local changes" above. Then you can push the patch(es) to
|
||||||
the main repo. If you are using ssh-access, all you need to do is:
|
the main repo. If you are using ssh-access, all you need to do is:
|
||||||
</P>
|
</P>
|
||||||
<PRE>
|
<PRE>
|
||||||
@@ -337,7 +338,7 @@ library after each change. In this case use this extended command:
|
|||||||
$ runghc Setup.hs build rgl-none
|
$ runghc Setup.hs build rgl-none
|
||||||
</PRE>
|
</PRE>
|
||||||
<P>
|
<P>
|
||||||
The resource library could also be compiled in two modes: with present tense only and
|
The resource library could also be compiled in two modes: with present tense only and
|
||||||
with all tenses. By default it is compiled with all tenses. If you want to use
|
with all tenses. By default it is compiled with all tenses. If you want to use
|
||||||
the library with only present tense you can compile it in this special mode with
|
the library with only present tense you can compile it in this special mode with
|
||||||
the command:
|
the command:
|
||||||
@@ -455,7 +456,7 @@ GF has testsuite. It is run with the following command:
|
|||||||
<P>
|
<P>
|
||||||
The testsuite architecture for GF is very simple but still very flexible.
|
The testsuite architecture for GF is very simple but still very flexible.
|
||||||
GF by itself is an interpreter and could execute commands in batch mode.
|
GF by itself is an interpreter and could execute commands in batch mode.
|
||||||
This is everything that we need to organize a testsuite. The root of the
|
This is everything that we need to organize a testsuite. The root of the
|
||||||
testsuite is the testsuite/ directory. It contains subdirectories which
|
testsuite is the testsuite/ directory. It contains subdirectories which
|
||||||
themself contain GF batch files (with extension .gfs). The above command
|
themself contain GF batch files (with extension .gfs). The above command
|
||||||
searches the subdirectories of the testsuite/ directory for files with extension
|
searches the subdirectories of the testsuite/ directory for files with extension
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
GF Developers Guide
|
GF Developers Guide
|
||||||
Authors: Björn Bringert and Krasimir Angelov
|
Authors: Björn Bringert and Krasimir Angelov
|
||||||
Last update: %%date(%c)
|
Last update: %%mtime(%c)
|
||||||
|
|
||||||
% NOTE: this is a txt2tags file.
|
% NOTE: this is a txt2tags file.
|
||||||
% Create an html file from this file using:
|
% Create an html file from this file using:
|
||||||
@@ -67,8 +67,9 @@ it first. Unfortunately editline does not have good support for Unicode. This wi
|
|||||||
if you tend to work on non-Latin language. Finaly readline supports both word completion
|
if you tend to work on non-Latin language. Finaly readline supports both word completion
|
||||||
and Unicode. Currently this is the best supported library.
|
and Unicode. Currently this is the best supported library.
|
||||||
|
|
||||||
Before to get the GF sources you also need Darcs. Darcs is a decentralized revision control system,
|
Before to get the GF sources you also need Darcs, version 2 or later.
|
||||||
see: http://darcs.net/ for more information. There are precompiled packages for many platforms available at
|
Darcs is a decentralized revision control system,
|
||||||
|
see http://darcs.net/ for more information. There are precompiled packages for many platforms available at
|
||||||
http://darcs.net/DarcsWiki/CategoryBinaries. There is also source code if you want to compile it yourself. Darcs is
|
http://darcs.net/DarcsWiki/CategoryBinaries. There is also source code if you want to compile it yourself. Darcs is
|
||||||
also written in Haskell and so you can use GHC to compile it.
|
also written in Haskell and so you can use GHC to compile it.
|
||||||
|
|
||||||
@@ -87,7 +88,7 @@ If you plan to work continuously on GF then you should consider to get read-writ
|
|||||||
Anyone can get the latest development version of GF by running (all on one line):
|
Anyone can get the latest development version of GF by running (all on one line):
|
||||||
|
|
||||||
```
|
```
|
||||||
$ darcs get --partial --set-scripts-executable http://code.haskell.org/gf/
|
$ darcs get --lazy --set-scripts-executable http://code.haskell.org/gf/
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create a directory called ``gf`` in the current
|
This will create a directory called ``gf`` in the current
|
||||||
@@ -174,10 +175,10 @@ Get your copy with (all on one line),
|
|||||||
replacing ``bringert`` with your own username on code.haskell.org:
|
replacing ``bringert`` with your own username on code.haskell.org:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ darcs get --partial --set-scripts-executable bringert@code.haskell.org:/srv/code/gf
|
$ darcs get --lazy --set-scripts-executable bringert@code.haskell.org:/srv/code/gf
|
||||||
```
|
```
|
||||||
|
|
||||||
The option ``--partial`` means that you do not download all of the
|
The option ``--lazy`` means that darcs defers downloading all the
|
||||||
history for the repository. This saves space, bandwidth and CPU time,
|
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
|
and most people don't need the full history of all changes in the
|
||||||
past.
|
past.
|
||||||
|
|||||||
Reference in New Issue
Block a user