GitHub/gf-core
1
0
Fork 1
mirror of https://github.com/GrammaticalFramework/gf-core.git synced 2026-04-09 04:59:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

Developer documentation updates prompted by the switch to darcs version 2

Browse Source 
In particular, the --lazy flag replaces the --partial flag.
This commit is contained in:
hallgren
2009-12-14 17:57:03 +00:00
parent 130417b541
commit 4f9d5a4a4c
2 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
doc/gf-developers.html
View File

@@ -8,7 +8,7 @@
<P ALIGN="center"><CENTER><H1>GF Developers Guide</H1>
<FONT SIZE="4">
<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>
<P></P>
@@ -101,14 +101,14 @@ in the following order:
<P>
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:
</P>
<PRE>
$ ghc-pkg list
</PRE>
<P>
which shows the list of all installed libraries.
which shows the list of all installed libraries.
</P>
<P>
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.
</P>
<P>
Before to get the GF sources you also need Darcs. 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
Before to get the GF sources you also need Darcs, version 2 or later.
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
also written in Haskell and so you can use GHC to compile it.
</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):
</P>
<PRE>
$ darcs get --partial --set-scripts-executable http://code.haskell.org/gf/
$ darcs get --lazy --set-scripts-executable http://code.haskell.org/gf/
</PRE>
<P></P>
<P>
@@ -168,7 +169,7 @@ 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
If you have added files, you first need to tell your local repository to
keep them under revision control:
</P>
<PRE>
@@ -198,7 +199,7 @@ repository.
<H3>Submitting patches</H3>
<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
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>
@@ -223,7 +224,7 @@ patch directly from darcs. If so, replace <CODE>-o mypatch.patch</CODE> with
<H2>Read-write access</H2>
<P>
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>.
Once you have an account, ask &lt;<A HREF="mailto:aarne@chalmers.se">aarne@chalmers.se</A>&gt; to add you to the <CODE>GF</CODE> project.
</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:
</P>
<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>
<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,
and most people don't need the full history of all changes in the
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
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,
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:
</P>
<PRE>
@@ -337,7 +338,7 @@ library after each change. In this case use this extended command:
$ runghc Setup.hs build rgl-none
</PRE>
<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
the library with only present tense you can compile it in this special mode with
the command:
@@ -455,7 +456,7 @@ GF has testsuite. It is run with the following command:
<P>
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.
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
themself contain GF batch files (with extension .gfs). The above command
searches the subdirectories of the testsuite/ directory for files with extension

13
doc/gf-developers.txt
View File

@@ -1,6 +1,6 @@
GF Developers Guide
Authors: Björn Bringert and Krasimir Angelov
Last update: %%date(%c)
Last update: %%mtime(%c)
% NOTE: this is a txt2tags file.
% 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
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,
see: http://darcs.net/ for more information. There are precompiled packages for many platforms available at
Before to get the GF sources you also need Darcs, version 2 or later.
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
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):
```
$ 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
@@ -174,10 +175,10 @@ Get your copy with (all on one line),
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,
and most people don't need the full history of all changes in the
past.