# Installation procedure

## Build documentation
1. Install the dependencies in an opam switch
   ```
   $ opam switch create geneweb 4.09.1
   $ opam install . --deps-only
   ```

2. Run the configuration script
   ```
   $ ocaml ./configure.ml
   ```

3. Build the distibution
   ```
   $ make clean distrib
   ```

## Configure
The `configure.ml` file is an ocaml script whose purpose is to
update `Makefile.config` by setting the environment variables
the `Makefile` needs.

```
usage: configure.ml [options]
  --gwdb-legacy Use legacy backend
  --release Use release profile: no debug informations (defaut: true)
  --debug Use dev profile: no optimization, debug informations (default: false)
  --sosa-legacy Use legacy Sosa module implementation
  --sosa-num Use Sosa module implementation based on `num` library
  --sosa-zarith Use Sosa module implementation based on `zarith` library
  --syslog Log gwd errors using syslog
  -help  Display this list of options
  --help  Display this list of options
```

## Build system

### Makefile 

The root of every action that could be performed on geneweb pass over its **Makefile**. In this section we will describe  the variables, targets and its dependencies.

#### Variables

Makefile loads variables from **Makefile.config** generated by the configuration script for customised execution of some commands. Variables with suffix `_D` are passed to [cppo](https://github.com/ocaml-community/cppo) command that preprocess files with an equivalent to the C preprocessor. Here is a description of those variables :

- `OS_TYPE` : kernel name (Linux, Win, Darwin, etc.)
- `STRIP` : command that discards symbols from compiled object files. Depends on kernel (linux command is ```strip```).
- `RM` : command that is used to remove files, directories, etc. Depends on kernel (linux command is ```/bin/rm -f```).
- `EXT` : extension for geneweb executable files. Depends on kernel (on Windows it's *.exe*).
- `GWDB_D` : argument to cppo command that defines a variable that tells which geneweb data base driver implementation will be used<!--TODO: link to gwdb driver doc--> (example : *GENEWEB_GWDB_LEGACY*).
- `OS_D` : argument to cppo command that defines a variable for current system (example : *UNIX*).
- `SYSLOG_D` : argument to cppo command that could define a marker variable *SYSLOG*. When defined, activate logging by geneweb server<!--TODO: link to gwd doc-->.
- `GWDB_PKG` : dune library that implements geneweb database driver<!--TODO: link to gwdb driver doc--> (example : *geneweb.gwdb-legacy*).
- `SOSA_PKG` : dune library that implements sosa<!--TODO: link to sosa doc --> (example : *geneweb_sosa_zarith*).
- `SYSLOG_PKG` : if *SYSLOG* is defined, then indicate dune library used for logging functionalities.
- `DUNE_DIRS_EXCLUDE` : specifies directories that will be excluded from *geneweb* library. Used to exclude not chosen implementations for sosa and for geneweb database driver.
- `DUNE_PROFILE` : specifies dune profile (default : release). 
  
Makefile also defines additional non-configurable variables :

- `PREFIX` : <!--TODO: fill information -->
- `DISTRIB_DIR` : directory where a local geneweb distribution is stored.
- `BUILD_DISTRIB_DIR` : directory where geneweb executable files for local distribution are stored.  
- `BUILD_DIR` : directory where the compiled artefacts are stored.
- `CPPO_D` : regroups all arguments to cppo (`GWDB_D`, `OS_D`, `SYSLOG_D`). If dune's profile is *dev* then also contains the definition of *DEBUG* variable that enables emitting warnings on stderr by geneweb server<!--TODO: link to gwd doc-->.
- `BENCH_FILE` : file where benchmark<!--TODO: link to benchmark doc--> results are stored. 

Nowadays geneweb is entirely compiled by [dune](https://dune.readthedocs.io/en/stable/index.html), due to *dune* files. Non-preprocessed version of *dune* files are stored in *dune<span>.</span>in*. Makefile is responsible for the generation of corresponding *dune* from the *dune<span>.</span>in*. Every *dune* file that should be generated is stored in variable `GENERATED_FILES_DEP` in addition to other files generated by Makefile :

```Makefile
GENERATED_FILES_DEP = \
	dune-workspace \
	hd/etc/version.txt \
	lib/dune \
	lib/gwdb/dune \
	lib/core/dune \
	lib/gwlib.ml \
	lib/util/dune \
	benchmark/dune \
	bin/connex/dune \
	bin/consang/dune \
	bin/fixbase/dune \
	bin/ged2gwb/dune \
	bin/gwb2ged/dune \
	bin/gwc/dune \
	bin/gwd/dune \
	bin/gwdiff/dune \
	bin/gwgc/dune \
	bin/gwrepl/dune \
	bin/gwrepl/.depend \
	bin/gwu/dune \
	bin/setup/dune \
	bin/update_nldb/dune \
	test/dune \
```

#### Targets

##### Main targets

- <span style="color:red">Makefile.config</span>: <span style="color:green">configure.ml</span><br/>
  
  Executed when *Makefile<span>.</span>config* isn't up-to-date with *configure<span>.</span>ml*. Prints corresponding error message and terminates execution. This target isn't executed when the goal is `ci` target.

- <span style="color:red">lib/gwlib.ml</span>:<br/>
  
  Generates the content for *lib/gwlib<span>.</span>ml*<!--TODO: link to gwlib doc --> that depends on `PREFIX`.

- <span style="color:red">bin/gwrepl/.depend</span>:<br/>
  
  Generates the content for *bin/gwrepl/.depend*.<!--TODO: describe where does it used and its content-->

- <span style="color:red">hd/etc/version.txt</span>:<br/>
  
  Generates the content for hd/etc/version<span>.</span>txt that indicates some information about geneweb version like date of compilation and commit used.

- <span style="color:red">%/dune</span>: <span style="color:green">%/dune.in Makefile.config</span><br/>
  
  Generates [dune](https://dune.readthedocs.io/en/stable/dune-files.html#dune) file from corresponding *dune<span>.</span>in* as follows:
  - Preprocess with ```cppo -n``` depending on `CPPO_D` argument.
  - Remplaces with [sed](https://www.gnu.org/software/sed/manual/sed.html) occurrences of <small>%%%CPPO_D%%%</small>, <small>%%%SOSA_PKG%%%</small>, <small>%%%GWDB_PKG%%%</small>, <small>%%%SYSLOG_PKG%%%</small> and <small>%%%DUNE_DIRS_EXCLUDE%%%</small> by the values of corresponding variables.

- <span style="color:red">dune-workspace</span>: <span style="color:green">dune-workspace.in Makefile.config</span><br/>
  
  Generates [dune-workspace](https://dune.readthedocs.io/en/stable/dune-files.html#dune-workspace) file that is used to define different build contexts and currently selected build profile. Generation is done by replacing the occurrence of <small>%%%DUNE_PROFILE%%%</small> inside *dune-workspace<span>.</span>in* by the value of corresponding variable.

- <span style="color:red">build</span>: <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Default goal when ```make``` is called without targets. Executes the target for every file specified in `GENERATED_FILES_DEP` and then build all public artefacts in geneweb package. 

- <span style="color:red">distrib</span>: <span style="color:green">build</span><br/>
  
  Principal target. Build entire system and creates a local distibution of geneweb under `DISTRIB_DIR` directory. See <!--link to user guide --> for more information.

- <span style="color:red">clean</span>:<br/>
  
  Removes all generated files that are specified in `GENERATED_FILES_DEP` and `DISTRIB_DIR`    

##### Additional targets

- <span style="color:red">generated</span>: <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes the target for every file specified in `GENERATED_FILES_DEP`.

- <span style="color:red">install</span>: <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes the target for every file specified in `GENERATED_FILES_DEP`, compilates all public artefacts and then install geneweb in opam.

- <span style="color:red">uninstall</span>: <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Same as **install** but remote geneweb from opam.

- <span style="color:red">doc</span>: | <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Generates documentation for all public artefacts in geneweb. Note that prerequisites on the right to `|` are [order-only](https://www.gnu.org/software/make/manual/html_node/Prerequisite-Types.html).

- <span style="color:red">test</span>: | <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes test suites<!--link to the test doc--> defined in *test* directory.

- <span style="color:red">bench</span>: | <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes the benchmark<!--link to the test benchmark--> defined in *benchmark* directory.

- <span style="color:red">bench-marshal</span>: | <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes the benchmark<!--link to the test benchmark--> with options ```--marshal --name ${BENCH_NAME} ${BENCH_FILE}``` where `BENCH_NAME` is the name of bench results that will be stored in hash table and marshalled in `BENCH_FILE`. Prerequisite to **ci** target.

- <span style="color:red">bench-tabulate</span>: | <span style="color:green">$(GENERATED_FILES_DEP)</span><br/>
  
  Executes the benchmark<!--link to the test benchmark--> with option ```--tabulate ${BENCH_FILE}``` that prints on the screen tables of bench results stored in `BENCH_FILE`. Prerequisite to **ci** target.

- <span style="color:red">ci</span>: <br/>
  
  - Configure geneweb for every existing implementation of sosa.
  - Executes tests and benchmarks (name corresponds to sosa implementation) for each of them (recursive make call with goals **clean**, **test**, **bench-marshal** **clean**).
  - Prints all benchmark results (recursive make call with goal **bench-tabulate**). 

### Dune configuration files

#### dune-project 

This file is used to mark the root of projects as well as define project-wide parameters. In the case of geneweb this file specifies version of the dune configuration files with `lang` stanza and sets the name of project with `name` stanza:

```lisp
(lang dune 2.8)
(name geneweb)
```

#### dune-workspace 

This file is used to define different build contexts and to select a build profile.
GeneWeb defines only one `default` context. Build profile (`release` or `dev`) is chosen by configuration script (```--release``` option to use release profile) with subsequent ```make```.

#### dune 

Dune files used to describe libraries, executables, tests, and everything dune needs to know about. Some of dune files are preprocessed by Makefile in order to remplace all occurences of <small>%%%VARIABLE%%%</small> by their real value (see [Variables](#variables)) In this section we will describe each of those file inside geneweb project.

```./dune```

The root dune file that, in the geneweb case, modifies the environment used with `dev` build profile. Particularly, it passes additional [option](https://ocaml.org/manual/native.html#s:native-options) to the OCaml compiler :

```bash
-w +a-4-9-35-42-44-48
```

This option tells to compiler to enable all the warnings except :
- Fragile pattern matching.
- Missing fields in a record pattern. 
- Unused for-loop index.
- Disambiguated constructor or label name.
- Open statement that shadows an already defined identifier.
- Implicit elimination of optional arguments. 

#### GeneWeb library

```lib/dune```

Defines public **geneweb** library <!--TODO: short description-->. 

- It includes modules under the `lib` directory and every of them is preprocessed with ```cppo```. 
- Module *TemplAst* is specified as a module without implementation (has only .mli).
- Module *Templ_parser* is obtained from *templ_parser.mll* with stanza `ocamllex` that makes call for [ocamllex](https://ocaml.org/manual/lexyacc.html#s:ocamllex-overview) lexer. 
- Compilation of this library includes compilation of every subdirectory (with `dirs` stanza) except those mentioned in <small>%%%DUNE_DIRS_EXCLUDE%%%</small> variable (not used implementations). 
- Depends on geneweb libraries :
   - geneweb_core
   - geneweb_def
   - geneweb_gwdb
   - geneweb_sosa_mli
   - geneweb_util
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
  - [stdlib-shims](https://docs.ocaml.pro/docs/META.stdlib-shims@stdlib-shims.0.3.0/index.html)
  - [camlp5](https://docs.ocaml.pro/docs/META.camlp5@camlp5.8.00.01/index.html)
  - [markup](https://docs.ocaml.pro/docs/META.markup@markup.1.0.0-1/index.html)

```lib/core/dune```

Defines public **geneweb.core** library (locally - **geneweb_core**)<!--TODO: short description-->.

- It includes modules under the `lib/core` directory and every of them is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb_def
  - geneweb_gwdb
  - geneweb_sosa_mli
  - geneweb_util
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```lib/def/dune```

Defines public **geneweb.def** library (locally - **geneweb_def**)<!--TODO: short description-->. Includes only two modules : *Adef* and *Def*.

```lib/gwdb/dune```

Defines public **geneweb.gwdb** library (locally - **geneweb_gwdb**)<!--TODO: short description-->.

- It includes modules under the `lib/gwdb` directory and every of them is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb_def
  - gwdb_driver_mli
  - geneweb_util
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```lib/gwdb_driver.mli/dune```

Defines public virtual (that requires an implementation) **geneweb.gwdb_driver** library (locally - **gwdb_driver_mli**)<!--TODO: short description-->.

- Include only one virtual module *Gwdb_driver*. 
- Depends on geneweb libraries :
  - geneweb_def
- Depends on extrenal libraries :
  - [re](https://docs.ocaml.pro/docs/META.re@re.1.9.0/index.html)

```lib/gwdb-legacy/dune```

Defines public **geneweb.gwdb-legacy** library (locally - **gwdb_legacy**)<!--TODO: short description-->. This library is an implementaion for virtual **gwdb_driver_mli** library.

- It includes modules under the `lib/gwdb-legacy` directory.
- Module *Dbdisk* is specified as a module without implementation.
- Depends on geneweb libraries :
  - geneweb_def
  - geneweb_util
- Depends on extrenal libraries :
  - [re](https://docs.ocaml.pro/docs/META.re@re.1.9.0/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```lib/json_export/dune```

Defines public **geneweb.export** library (locally - **geneweb_export**)<!--TODO: short description-->.

- Include only one module *Json_converter*. 
- Depends on geneweb libraries :
  - geneweb_def
  - geneweb_def_show
  - geneweb_gwdb
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```lib/show/dune```

Defines public **geneweb.def_show** library (locally - **geneweb_def_show**)<!--TODO: short description-->.

- Include only one module *Def_show*. This module is preprocessed with [ppx_import](https://github.com/ocaml-ppx/ppx_import) and [ppx_deriving.show](https://github.com/ocaml-ppx/ppx_deriving#plugin-show) PPX rewriters that require feedback from the compilation phase (for that it is used inside `staged_pps` stanza rather than in ordinar `pps`). 
- Depends on geneweb libraries :
  - geneweb_def
  - geneweb_gwdb

```lib/sosa.mli/dune```

Defines public virtual **geneweb.sosa.mli** library (locally - **geneweb_sosa_mli**)<!--TODO: short description-->. Includes only one virtual module *Sosa*.

```lib/sosa_array/dune```

Defines public **geneweb.sosa_array** library (locally - **geneweb_sosa_array**)<!--TODO: short description-->. This library is an one of implementaions for virtual **geneweb_sosa_mli** library. It includes only one module *Sosa*. 

```lib/sosa_num/dune```

Defines public **geneweb.sosa_num** library (locally - **geneweb_sosa_num**)<!--TODO: short description-->. This library is an one of implementaions for virtual **geneweb_sosa_mli** library. 

- It includes only one module *Sosa*. 
- Depends on extrenal libraries :
  - [num](https://docs.ocaml.pro/docs/META.num@num.1.4/index.html)
  
```lib/sosa_zarith/dune```

Defines public **geneweb.sosa_zarith** library (locally - **geneweb_sosa_zarith**)<!--TODO: short description-->. This library is an one of implementaions for virtual **geneweb_sosa_mli** library. 

- It includes only one module *Sosa*. 
- Depends on extrenal libraries :
  - [zarith](https://docs.ocaml.pro/docs/META.zarith@zarith.1.11/index.html)

```lib/util/dune```

Defines public **geneweb.util** library (locally - **geneweb_util**)<!--TODO: short description-->.

- It includes modules under the `lib/util` directory and every of them is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb_def
- Depends on extrenal libraries :
  - [calendars](https://docs.ocaml.pro/docs/META.calendar@calendar.2.04/index.html)
  - [stdlib-shims](https://docs.ocaml.pro/docs/META.stdlib-shims@stdlib-shims.0.3.0/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
  - [unidecode](https://github.com/geneweb/unidecode)
  - [re](https://docs.ocaml.pro/docs/META.re@re.1.9.0/index.html)
  - [uucp](https://docs.ocaml.pro/docs/META.uucp@uucp.13.0.0/index.html)
  - [uunf](https://docs.ocaml.pro/docs/META.uunf@uunf.13.0.0/index.html)
  - [uutf](https://docs.ocaml.pro/docs/META.uutf@uutf.1.0.2/index.html)

##### GeneWeb executables

```bin/connex/dune```

Defines public **geneweb.connex** executable (locally - **connex**)<!--TODO: short description-->.

- It includes only one module *Connex*.  
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/consang/dune```

Defines public **geneweb.consang** executable (locally - **consang**)<!--TODO: short description-->.

- It includes only one module *Consang* that is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/fixbase/dune```

Defines public **geneweb.gwfixbase** executable (locally - **gwfixbase**)<!--TODO: short description-->.

- It includes only one module *Gwfixbase*.
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/ged2gwb/dune```

Defines public **geneweb.ged2gwb** executable (locally - **ged2gwb**)<!--TODO: short description-->.

- It includes only one module *Ged2gwb* preprocessed by [camlp5o](https://camlp5.github.io/doc/html/) that provides parsing and pretty printing tools. Particulary, it uses following extensions:
  - `pr_o.cmo`: pretty print in normal syntax
  - `pa_extend.cmo`: syntax extension for grammars
  - `q_MLast.cmo`: syntax tree nodes (in revised syntax)
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/gwb2ged/dune```

Defines :
1. Public **geneweb.gwb2ged_lib** library (locally - **gwb2ged_lib**)<!--TODO: short description-->.
   - It includes only one module *Gwb2gedLib*.
   - Depends on geneweb libraries :
     - geneweb
     - gwexport_lib
2. Public **geneweb.gwb2ge** executable (locally - **gwb2ged**)<!--TODO: short description-->.
   - It includes only one module *Gwb2ged*.
   - Depends on geneweb libraries :
     - geneweb
     - gwb2ged_lib
     - gwu_lib 
     - Chosen implementation of gwdb_driver_mli.
     - Chosen implementation of geneweb_sosa_mli. 
   - Depends on extrenal libraries :
     - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html) 

```bin/gwc/dune```

Defines public **geneweb.gwc** executable (locally - **gwc**)<!--TODO: short description-->.

- It includes modules under the `bin/gwc` directory and every of them is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/gwd/dune```

Defines:

1. Public wrapped **geneweb.gwd_lib** library (locally - **gwd_lib**)<!--TODO: short description-->.
   - It includes modules *GwdLog*, *GwdPlugin* and *Request* that are preprocessed with ```cppo```.
   - Depends on geneweb libraries :
     - geneweb
     - wserver
     - Chosen implementation of gwdb_driver_mli.
     - Chosen implementation of geneweb_sosa_mli.
2. Public executable **geneweb.gwd** library (locally - **gwd**)<!--TODO: short description-->.
   - It includes modules *Gwd*, *GwdPluginDep*, *GwdPluginMD5*, *GwdPluginMETA* and *Robot* that are preprocessed with ```cppo```.
   - Module *GwdPluginMD5* is created by `rule` stanza. Stanza `deps` tells to dune to do firstly:
     - Find module *Mk_gwdPluginMD5*
     - Construct all recursively defined in ```plugins/``` aliases `@plugin`. 
   File ```gwdPluginMD5.ml``` is created by running maker script ```mk_gwdPluginMD5.ml``` with path to ```plugins/``` directory specified in argument.
   - All the libraies used by executable are compiled with `-linkall` flag.
   - Depends on geneweb libraries :
     - gwd_lib
     - geneweb
     - wserver
     - Chosen implementation of gwdb_driver_mli.
     - Chosen implementation of geneweb_sosa_mli. 
   - Depends on extrenal libraries :
     - [dynlink](https://docs.ocaml.pro/docs/META.dynlink@ocamlfind.1.9.1/index.html)
     - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
 
```bin/gwdiff/dune```

Defines public **geneweb.gwdiff** executable (locally - **gwdiff**)<!--TODO: short description-->.

- It includes only one module *Gwdiff*.
- Depends on geneweb libraries :
   - geneweb
   - Chosen implementation of gwdb_driver_mli.
   - Chosen implementation of geneweb_sosa_mli. 
- Depends on extrenal libraries :
   - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
   - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/gwexport/dune```

Defines public **geneweb.gwexport_lib** library (locally - **gwexport_lib**)<!--TODO: short description-->.

- It includes only one module *Gwexport*.
- Depends on geneweb libraries :
   - geneweb

```bin/gwgc/dune```

Defines public **geneweb.gwgc** executable (locally - **gwgc**)<!--TODO: short description-->.

- It includes only one module *Gwgc* that is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/gwrepl/dune```

Defines:

1. Private library **gwrepl_deps** that links all dependent libraries<!--TODO: short description-->.
   - Depends on geneweb libraries :
     - geneweb_core
     - geneweb_def
     - geneweb_util
     - geneweb_gwdb
     - Chosen implementation of gwdb_driver_mli.
     - Chosen implementation of geneweb_sosa_mli.
   - Depends on external libraries   
     - [stdlib](https://docs.ocaml.pro/docs/LIBRARY.stdlib@ocaml-base-compiler.4.10.0/index.html)
     - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
2. Public **gwrepl** executable <!--TODO: short description-->.
   - It includes only two modules *Gwrepl* and *Data*.
   - **gwrepl** executable is preprocessed with ```cppo```.
   - Module *Data* is created with `rule` stanza from :
     - Module *Mk_data*
     - File ```.depend``` <!--TODO : what does this file do-->.<br/> 
     File ```data.ml``` is created by running maker script ```mk_data.ml``` that is linked with ```unix.cma``` by OCaml toplevel.
   - *Data* is preprocessed with [ppx_blob](https://github.com/johnwhitington/ppx_blob) that is used to extract the content of binary file at compile time.
   - It is compiled by bytecode compiler and producing static object files:
     ```lisp
     (modes byte object)
     ``` 
   - All the libraies used by executable are compiled with `-linkall` flag.
   - Linked with ```-custom``` option that is used by bytecode compiler to produce native executable that embeds the ocamlrun virtual machine as well as the byte code. See [dune-executable](https://dune.readthedocs.io/en/stable/dune-files.html#executable).
   - Depends on external libraries:
     - [compiler-libs.toplevel](https://docs.ocaml.pro/docs/META.compiler-libs.toplevel@ocamlfind.1.9.1/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

```bin/gwu/dune```

Defines :
1. Public **geneweb.gwu_lib** library (locally - **gwu_lib**)<!--TODO: short description-->.
   - It includes only one module *GwuLib*.
   - Depends on geneweb libraries :
     - geneweb
     - gwexport_lib
2. Public **geneweb.gwu** executable (locally - **gwu**)<!--TODO: short description-->.
   - It includes only one module *Gwu*.
   - Depends on geneweb libraries :
     - geneweb
     - gwexport_lib
     - gwu_lib 
     - Chosen implementation of gwdb_driver_mli.
     - Chosen implementation of geneweb_sosa_mli. 
   - Depends on extrenal libraries :
     - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html) 

```bin/setup/dune```

Defines public **geneweb.setup** executable (locally - **setup**)<!--TODO: short description-->.

- It includes only one module *Setup* that is preprocessed with ```cppo```.
- Depends on geneweb libraries :
  - geneweb
  - wserver
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
  - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)

```bin/update_nldb/dune```

Defines public **geneweb.update_nldb** executable (locally - **update_nldb**)<!--TODO: short description-->.

- It includes only one module *Update_nldb*.
- Depends on geneweb libraries :
   - geneweb
   - Chosen implementation of gwdb_driver_mli.
   - Chosen implementation of geneweb_sosa_mli. 
- Depends on extrenal libraries :
   - [str](https://docs.ocaml.pro/docs/META.str@ocamlfind.1.9.1/index.html)
   - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)


```bin/wserver/dune```

Defines public **geneweb.wserver** library (locally - **wserver**)<!--TODO: short description-->.

- It includes only one module *Wserver*. 
- Depends on geneweb libraries :
  - geneweb_util
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)

##### GeneWeb plugins

```plugins/cgl/dune```

Defines plugin **plugin_cgl**<!--TODO: short description-->. 

- It includes only one module *Plugin_cgl*. 
- Plugin is compiled by native compiler with
  ```lisp
  (modes (native plugin))
  ```
- Construction of `@plugin` alias depends on plugin's compilation.
- Depends on geneweb libraries :
  - geneweb
  - gwd_lib
  - wserver

```plugins/export/dune```

Defines plugin **plugin_export**<!--TODO: short description-->. 

- It includes only one module *Plugin_export*.
- Plugin is compiled by native compiler.
- Construction of `@plugin` alias depends on plugin's compilation.
- Compiled with flags that tells to compiler to disable warnings:
  - Innocuous unused variable.
  - Constructor or label name used out of scope. 
- Linked statically with libraries :
  - gwexport_lib
  - gwu_lib
  - gwb2ged_lib
- Depends on geneweb libraries :
  - geneweb
  - gwd_lib
  - gwb2ged_lib
  - gwexport_lib
  - gwu_lib
  - wserver

```plugins/fixbase/dune```

Defines plugin **plugin_fixbase**<!--TODO: short description-->. 

- It includes only one module *Plugin_fixbase*.
- Plugin is preprocessed with [ppx_deriving.show](https://github.com/ocaml-ppx/ppx_deriving#plugin-show).
- Plugin is compiled by native compiler with ```-linkall``` option.
- Construction of `@plugin` alias depends on:
  - Plugin's compilation
  - Every file from *assets* directory.
- Depends on geneweb libraries :
  - gwd_lib
  - geneweb_def_show

```plugins/forum/dune```

Defines plugin **plugin_forum**<!--TODO: short description-->. 

- It includes only one module *Plugin_forum* that was obtained by preprocessoing corresponding ```.cppo.ml```. Stanza `rule` in this context is used to remplace lines with directive ```#include``` by one of included file :
```lisp
(rule
  (target plugin_forum.ml)
  (deps
    (:included
      %{project_root}/plugins/forum/forum.ml
      %{project_root}/plugins/forum/forumDisplay.ml
    )
    (:src plugin_forum.cppo.ml)
  )
  (action (run %{bin:cppo} %{src} -o %{target}))
```
- Plugin is compiled by native compiler.
- Construction of `@plugin` alias depends on plugin's compilation.
- Depends on geneweb libraries :
  - geneweb
  - gwd_lib
  - wserver

```plugins/gwxjg/dune```

Defines :

1. Public **geneweb.plugin_gwxjg_lib** library (locally - **plugin_gwxjg_lib**)<!--TODO: short description-->.
   - It includes modules *Gwxjg_ezgw*, *Gwxjg_data*, *Gwxjg_trans* and *Gwxjg_lexicon_parser*.
   - Module *Gwxjg_lexicon_parser* is obtained from *gwxjg_lexicon_parser.mll* with stanza `ocamllex` that makes call for [ocamllex](https://ocaml.org/manual/lexyacc.html#s:ocamllex-overview) lexer.
   - Compiled with flags that tells to compiler to disable warnings:
     - Constructor or label name used out of scope.
     - Disambiguated constructor or label name.
   - Depends on geneweb libraries :
     - geneweb
   - Depends on external libraries :
     - [jingoo](https://docs.ocaml.pro/docs/META.jingoo@jingoo.1.4.3/index.html)
     - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
2. Plugin **plugin_gwxjg**<!--TODO: short description-->. 
   - It includes only one module *Plugin_gwxjg*.
   - Plugin is compiled by native compiler with ```-linkall``` option.
   - Construction of `@plugin` alias depends on:
     - Plugin's compilation
     - *META* file.
   - Linked statically with libraries :
     - plugin_gwxjg_lib
   - Depends on geneweb libraries :
     - gwd_lib
     - plugin_gwxjg_lib

```plugins/jingoo/dune```

Defines plugin **plugin_jingoo**<!--TODO: short description-->. 

- It includes only one module *Plugin_jingoo*.
- Plugin is compiled by native compiler with ```-linkall``` option.
- Construction of `@plugin` alias depends on plugin's compilation.
- Linked statically with libraries :
  - [jingoo](https://docs.ocaml.pro/docs/META.jingoo@jingoo.1.4.3/index.html)
- Depends on geneweb libraries :
  - gwd_lib

```plugins/lib_show/dune```

Defines plugin **plugin_lib_show**<!--TODO: short description-->. 

- It includes only one module *Plugin_lib_show*.
- Plugin is compiled by native compiler with ```-linkall``` option.
- Construction of `@plugin` alias depends on plugin's compilation.
- Linked statically with libraries :
  - geneweb_def_show

```plugins/no_index/dune```

Defines plugin **plugin_no_index**<!--TODO: short description-->. 

- It includes only one module *Plugin_no_index*.
- Plugin is compiled by native compiler.
- Construction of `@plugin` alias depends on plugin's compilation.
- Depends on geneweb libraries :
  - geneweb
  - gwd_lib
  - wserver

```plugins/v7/dune```

1. Wrapped **plugin_v7_lib** library<!--TODO: short description-->.
   - It includes modules starting with prefix ```V7```.
   - Depends on geneweb libraries :
     - geneweb
     - geneweb_util
     - gwd_lib
2. Plugin **plugin_v7**<!--TODO: short description-->. 
   - It includes only one module *Plugin_v7*.
   - Plugin is compiled by native compiler with ```-linkall``` option.
   - Construction of `@plugin` alias depends on:
     - Plugin's compilation
     - Every file from *assets* directory.
   - Linked statically with libraries :
     - plugin_v7_lib
   - Depends on geneweb libraries :
     - gwd_lib
     - plugin_v7_lib

```plugins/v7_im/dune```

1. Wrapped **plugin_v7_im_lib** library<!--TODO: short description-->.
   - It includes only one module *V7_im_sendImage*.
   - Depends on geneweb libraries :
     - geneweb_util
     - gwd_lib
2. Plugin **plugin_v7**<!--TODO: short description-->. 
   - It includes only one module *Plugin_v7_im*.
   - Plugin is compiled by native compiler.
   - Construction of `@plugin` alias depends on plugin's compilation.
   - Linked statically with libraries :
     - plugin_v7_im_lib
   - Depends on geneweb libraries :
     - gwd_lib
     - plugin_v7_im_lib

```plugins/welcome/dune```

Defines plugin **plugin_welcome**<!--TODO: short description-->. 

- It includes only one module *Plugin_welcome*.
- Plugin is compiled by native compiler with ```-linkall``` option.
- Construction of `@plugin` alias depends on: 
  - Plugin's compilation.
  - Every file from *assets* directory.
  - *META* file.
- Depends on geneweb libraries :
  - gwd_lib
  - wserver
  - plugin_v7_lib

##### GeneWeb tests

```test/dune```

Defines:

1. **dummy_gwdb** library <!--TODO: short description-->that is an implementation for **gwdb_driver_mli** virtual library.
   - It includes only one module *Gwdb_driver*.
   - Depends on geneweb libraries:
     - geneweb_def
   - Depends on external libraries:
     - [stdlib-shims](https://docs.ocaml.pro/docs/META.stdlib-shims@stdlib-shims.0.3.0/index.html)
2. **test** executable<!--TODO: short description-->.
   - It includes modules starting with prefix ```Test``` that are preprocessed with [ppx_deriving.show](https://github.com/ocaml-ppx/ppx_deriving#plugin-show) PPX rewriter.
   - Construction of `@runtest` alias depends on execution of **test**.
   - Depends on geneweb libraries:
     - geneweb
     - dummy_gwdb
     - Chosen implementation of geneweb_sosa_mli. 
   - Depends on external libraries:
     - [stdlib-shims](https://docs.ocaml.pro/docs/META.stdlib-shims@stdlib-shims.0.3.0/index.html)
     - [oUnit](https://docs.ocaml.pro/docs/META.oUnit@ounit.2.0.8/index.html)

##### GeneWeb benchmarks

```benchmark/dune```

Defines **bench** executable<!--TODO: short description-->.

- It includes only one module *Bench* that is preprocessed with ```cppo```.
- Construction of `@runbench` alias depends on execution of **bench**.
- Depends on geneweb libraries :
  - geneweb
  - Chosen implementation of gwdb_driver_mli.
  - Chosen implementation of geneweb_sosa_mli.
- Depends on extrenal libraries :
  - [unix](https://docs.ocaml.pro/docs/META.unix@ocamlfind.1.9.1/index.html)
  - [benchmark](https://docs.ocaml.pro/docs/META.benchmark@benchmark.1.6/index.html)