From 23c0439692d18430d60e7e500d17fc5b1e805305 Mon Sep 17 00:00:00 2001
From: Erwan Jahier <erwan.jahier@univ-grenoble-alpes.fr>
Date: Thu, 24 Oct 2019 00:08:59 +0200
Subject: [PATCH] Doc: the link to the odoc generated pages was not working
---
guides/users/README.md | 89 ++++++++++++++++++++---------------------
guides/users/README.org | 2 +-
2 files changed, 44 insertions(+), 47 deletions(-)
diff --git a/guides/users/README.md b/guides/users/README.md
index 13bbcefe..b76f8119 100644
--- a/guides/users/README.md
+++ b/guides/users/README.md
@@ -1,26 +1,26 @@
# Table of Contents
-1. [TL;DR](#org894d8ce)
-2. [Topology](#org4cc393b)
-3. [Algorithms](#orga7945a0)
-4. [Examples](#orgbbf247a)
-5. [Batch mode](#orgf683e52)
- 1. [Running batch simulations with Built-in demons](#orgc61d0c6)
- 2. [Running batch simulations with manual demons](#orgbb32fc7)
- 3. [Running batch simulations with `lurette`](#org0e74651)
- 4. [Viewing Results](#org81f11cd)
- 5. [The `sasa` CLI](#org0383e07)
-6. [Interactive mode](#org02765ee)
- 1. [Running interactive sessions with `rdbg`](#orgefe2347)
-7. [Install](#org52a413e)
- 1. [Via opam (prefered method)](#orgb7b3818)
- 2. [From source](#orgf464ad7)
-8. [More](#org9d27083)
-9. [FAQ](#orgebde806)
- 1. [Is there a FAQ?](#org3dc6690)
-
-
-<a id="org894d8ce"></a>
+1. [TL;DR](#org22df16e)
+2. [Topology](#org084693b)
+3. [Algorithms](#org7714be5)
+4. [Examples](#org751f0d0)
+5. [Batch mode](#orgd888135)
+ 1. [Running batch simulations with Built-in demons](#orgde8abea)
+ 2. [Running batch simulations with manual demons](#orgad6b949)
+ 3. [Running batch simulations with `lurette`](#orgc770247)
+ 4. [Viewing Results](#org0e8ce0e)
+ 5. [The `sasa` CLI](#org0d3c2ec)
+6. [Interactive mode](#orgd6f3f49)
+ 1. [Running interactive sessions with `rdbg`](#orgc33a722)
+7. [Install](#org2ab3811)
+ 1. [Via opam (prefered method)](#org7c6e22c)
+ 2. [From source](#orgc2f967e)
+8. [More](#orgcd62084)
+9. [FAQ](#org33cd4c0)
+ 1. [Is there a FAQ?](#org356307f)
+
+
+<a id="org22df16e"></a>
# TL;DR
@@ -44,7 +44,7 @@ sasa ring.dot
The source code is available at <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
-<a id="org4cc393b"></a>
+<a id="org084693b"></a>
# Topology
@@ -107,19 +107,19 @@ Such parameters can be retreived in Algorithms using the `Algo.get_graph_attribu
nb: a `Algo.diameter: unit -> int` function is provided, but it can be expensive to use.
-<a id="orga7945a0"></a>
+<a id="org7714be5"></a>
# Algorithms
The following has been generated from [algo.mli](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/blob/master/lib/algo/algo.mli)
<div class="html">
-<iframe title="The Algo API" width="700" height="700" src="<_html/algo/Algo/index.html>";></iframe>
+<iframe title="The Algo API" width="700" height="700" src="<https://verimag.gricad-pages.univ-grenoble-alpes.fr/synchrone/sasa/_html/algo/Algo/index.html>";></iframe>
</div>
-<a id="orgbbf247a"></a>
+<a id="org751f0d0"></a>
# Examples
@@ -147,12 +147,12 @@ The `test` directory also contains sub-directories which gathers programs shared
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="orgf683e52"></a>
+<a id="orgd888135"></a>
# Batch mode
-<a id="orgc61d0c6"></a>
+<a id="orgde8abea"></a>
## Running batch simulations with Built-in demons
@@ -177,7 +177,7 @@ sasa -h | grep "\-demon"
--custom-demon, -custd
-<a id="orgbb32fc7"></a>
+<a id="orgad6b949"></a>
## Running batch simulations with manual demons
@@ -204,7 +204,7 @@ It can also by simulated by [`lutin`](http://www-verimag.imag.fr/DIST-TOOLS/SYNC
Built-in demons can of course be programmed in Lutin. One can generate such demons using the `--gen-lutin-demon` option: `sasa --gen-lutin-demon a_graph.dot`. It can be handy at least to get the demons variables names in the good order if one to write its own demon.
-<a id="org0e74651"></a>
+<a id="orgc770247"></a>
## Running batch simulations with `lurette`
@@ -227,14 +227,14 @@ lurette \
```
-<a id="org81f11cd"></a>
+<a id="org0e8ce0e"></a>
## Viewing Results
`sasa -rif` and `lurette` generates `.rif` files that can be viewed with `gnuplot-rif` or `sim2chro`; cf <http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6/>
-<a id="org0383e07"></a>
+<a id="org0d3c2ec"></a>
## The `sasa` CLI
@@ -256,18 +256,12 @@ sasa --help
Use a Distributed demon (which select at least one action). This is the default demon.
--custom-demon, -custd
Use a Custom demon (forces --rif)
- --rif, -rif Display only outputs on stdout (i.e., behave as a rif input file)
- --no-log, -rif
- Display only outputs on stdout (i.e., behave as a rif input file)
--seed, -seed
Set the pseudo-random generator seed of build-in demons (wins over --replay)
--replay, -replay
Use the last generated seed to replay the last run
--gen-register, -reg
- Generates the registering file and exit.
-
-
-
+ Generates the registering file and exit.
--length, -l <int>
Maximum number of steps to be done (10000 by default).
@@ -285,6 +279,9 @@ More `sasa` options:
sasa --more
```
+ --rif, -rif Display only outputs on stdout (i.e., behave as a rif input file)
+ --no-data-file, -nd
+ Do not generate any data file
--gen-lutin-demon, -gld
Generate Lutin demons and exit
--gen-lustre-oracle-skeleton, -glos
@@ -300,7 +297,7 @@ sasa --more
Display the version ocaml version sasa was compiled with and exit.
-<a id="org02765ee"></a>
+<a id="orgd6f3f49"></a>
# Interactive mode
@@ -313,7 +310,7 @@ The [test](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/t
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="orgefe2347"></a>
+<a id="orgc33a722"></a>
## Running interactive sessions with `rdbg`
@@ -378,12 +375,12 @@ rdbg
Typing '0' will therefore also load the `rdbg_session.ml` file we have just been using.
-<a id="org52a413e"></a>
+<a id="org2ab3811"></a>
# Install
-<a id="orgb7b3818"></a>
+<a id="org7c6e22c"></a>
## Via opam (prefered method)
@@ -408,7 +405,7 @@ opam install -y rdbg lutin
```
-<a id="orgf464ad7"></a>
+<a id="orgc2f967e"></a>
## From source
@@ -424,7 +421,7 @@ You will need:
One can mimick the content of the `test` job in the project [Gitlab CI script](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/blob/master/.gitlab-ci.yml).
-<a id="org9d27083"></a>
+<a id="orgcd62084"></a>
# More
@@ -432,12 +429,12 @@ One can mimick the content of the `test` job in the project [Gitlab CI script](h
- Sources: <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
-<a id="orgebde806"></a>
+<a id="org33cd4c0"></a>
# FAQ
-<a id="org3dc6690"></a>
+<a id="org356307f"></a>
## Is there a FAQ?
diff --git a/guides/users/README.org b/guides/users/README.org
index 56f444d6..69ee3c80 100644
--- a/guides/users/README.org
+++ b/guides/users/README.org
@@ -109,7 +109,7 @@ The following has been generated from [[https://gricad-gitlab.univ-grenoble-alpe
<iframe title="The Algo API"
width="700"
height="700"
- src="file:_html/algo/Algo/index.html";></iframe>
+ src="https://verimag.gricad-pages.univ-grenoble-alpes.fr/synchrone/sasa/_html/algo/Algo/index.html";></iframe>
#+end_html
* Examples
--
GitLab