Commit 8cef140c authored by Benoit Rat's avatar Benoit Rat

doc: minor markdown syntax fixes

parent a476e183
......@@ -277,8 +277,12 @@ experiments you will need:
* The Operative System **Ubuntu LTS 64bit (Long Term Support)** installed.
* Two mini-USB (B) cables (not provided with the kit).
This tutorial has been tested and verified with Ubuntu LTS 16.04.6 (kernel v.4.15.9) and Ubuntu LTS 18.04.2 (kernel v.4.18.0-17), this mean that standard support will only be given for these releases.
However, the `spec-sw` driver should work with other releases, distributions and architectures. Ubuntu 18.04 LTS is supported but some versions like 18.04.1 or 18.04.3(with kernel version 5.0) does not work correctly unless you [set a previous kernel version](#Set-Previous-Kernel-Version). Ubuntu LTS 14.04 is not supported.
This tutorial has been tested and verified with Ubuntu LTS 16.04.6 (kernel v.4.15.9) and Ubuntu LTS 18.04.2 (kernel v.4.18.0-17), this mean that **standard support will only be given for these releases**.
However, the `spec-sw` driver should work with other releases, distributions and architectures.
> ***Notes:*** Ubuntu 18.04 LTS is supported but some versions like 18.04.1 or 18.04.3 (with kernel version 5.0) does not work correctly unless you [set a previous kernel version](#Set-Previous-Kernel-Version).
> ***Warning:*** Ubuntu LTS 14.04 is not supported.
![Configuration with one two PCs](img/ssk_configs.png)
......@@ -292,8 +296,8 @@ in the package[^standardssk] :
* 2x [FMC-DIO]s 5CH TTL A
* 2x SFPs LC
* AXGE-1254-0531 (blue)
* AXGE-3454-0531 (violet)
* AXGE-1254-0531 (blue)
* AXGE-3454-0531 (violet)
* 1x LC-LC cable (2m)
* 3x LEMO cable (2m)
* 3x LEMO-BNC Adaptor
......@@ -352,6 +356,7 @@ You should obtain something similar as:
~~~~~~~~~~
Where `01` represent the ID of the PCIe slot given by your motherboard.
> **Note**: The PCIe slot numbering are normally ordered from top to bottom on the motherboard,
this mean that the board with ID `01` will be above.
......@@ -446,7 +451,7 @@ written with proper value as explained in the next section.
Creating Valid EEPROM
----------------------
> ***Notes***: If you already have the new interfaces wrX while doing
> ***Notes:*** If you already have the new interfaces wrX while doing
`ifconfig`, this mean that you can **skip** this section.
On older manufactured [FMC-DIO] (before 2014), the EEPROM was not
......@@ -842,7 +847,7 @@ It is also recommended to follow the order of the tutorial since the
concepts that are intended to be described and tested are explained in
the same order as the experiments.
> **Notes:** Before each experiment you should make sure that you set
> ***Notes:*** Before each experiment you should make sure that you set
up your boards in *master/slave* mode and that the PTP daemons are running on both.
......@@ -1415,11 +1420,11 @@ If you use a custom gateware or SFPs that are not listed in the wiki page
you should run yourself the calibration in order to obtain the correct values
for your setup.
> **Warning**: Cable length/type can modify around ~5ns/meter the delay
> ***Warning:*** Cable length/type can modify around ~5ns/meter the delay
between the moment when the PPS was out of the board and when it was
captured by the oscilloscope.
> **Notes**: Please check that you are using the values that correspond
> ***Notes:***: Please check that you are using the values that correspond
to your gateware release. When this document was generated we refer as
wr-starting-kit-v3.0 (starting kit). You can also check using the `ver` command
if the corresponding embedded LM32 corresponds to your gateware version.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment