From 27519a97c207b04b8fc253dfb361d0a3d0dfb7ee Mon Sep 17 00:00:00 2001
From: Erik Kooistra <kooistra@astron.nl>
Date: Tue, 18 Nov 2014 07:09:15 +0000
Subject: [PATCH] Mentioned that set_modelsim is used in run_modelsim and
 similar set_quartus is used in run_quartus. Both are used in
 run_altera_simlib_comp.

---
 tools/hdltool_readme.txt | 50 +++++++++++++++++++++-------------------
 1 file changed, 26 insertions(+), 24 deletions(-)

diff --git a/tools/hdltool_readme.txt b/tools/hdltool_readme.txt
index 7d4a243c6f..d722b20eea 100644
--- a/tools/hdltool_readme.txt
+++ b/tools/hdltool_readme.txt
@@ -6,11 +6,12 @@ Contents:
   a) ~/.bashrc
   b) Python environment setup
   c) Tool environment setup scripts
-  d) Tool start scripts
-  e) How to start Modelsim for RadioHDL
-  f) How to start Quartus for RadioHDL
-  g) How to start Modelsim for UNB
-  h) How to start Quartus for UNB
+  d) Compiling the Altera libraries for simulation with Modelsim
+  e) Tool start scripts
+  f) How to start Modelsim for RadioHDL
+  g) How to start Quartus for RadioHDL
+  h) How to start Modelsim for UNB
+  i) How to start Quartus for UNB
   
 3) HDL environment configuration files
   a) Tools and libraries
@@ -28,8 +29,7 @@ Contents:
   c) Simulation
   
 7) Synthesis in Quartus
-  a) Compiling the Altera libraries for simulation with Modelsim
-  b) Creating the Quartus project files
+  a) Creating the Quartus project files
 
 8) Design revisions
   
@@ -108,13 +108,24 @@ Some environment variables need to be set in the .bashrc, because they are not k
   - The $LM_LICENSE_FILE environment variable, because it is site specific.
   - The $PATH to the python installation directory, because it is machine specific and may also be used for other projects. 
 
-d) Tool start scripts
+d) Compiling the Altera libraries for simulation with Modelsim
+
+The Altera verilog and vhdl libraries for the required FPGA device families can be compile using:
+
+ > tools/quartus/run_altera_simlib_comp <tool target> <compilation output directory> <FPGA device family>
+
+This run_altera_simlib_comp script must be used and not the tools/Launch simulation library compiler in the Quartus GUI, because
+the libraries have to be compiled with the 'vlib -type directory' option to be able to use 'mk all'. 
+
+The run_altera_simlib_comp uses set_modelsim and set_quartus to make the tool settings for Modelsim and Quartus.
+
+e) Tool start scripts
 
 The definitions for actually running Modelsim and Quartus are not kept in the ~/.bashrc file or the setup script but are
 set in a tool start script:
 
-  $RADIOHDL/tools/modelsim/run_modelsim
-  $RADIOHDL/tools/quartus/run_quartus
+  $RADIOHDL/tools/modelsim/run_modelsim      # calls set_modelsim and starts the Modelsim GUI for simulation
+  $RADIOHDL/tools/quartus/run_quartus        # calls set_quartus and starts the Quartus GUI for synthesis
 
 The paths to these tool start scripts are defined in setup_radiohdl.sh. In addition to the advantages mentioned above for the environment setup scripts,
 the advantages of using a seperate tool start script is:
@@ -123,7 +134,7 @@ the advantages of using a seperate tool start script is:
     only apply to the started tool environment
 
 
-e) How to start Modelsim for RadioHDL
+f) How to start Modelsim for RadioHDL
 
 To start Modelsim for RadioHDL do:
 
@@ -149,7 +160,7 @@ The commands.do defines the following extra commands that can be used at the Mod
   . ds        : delete all signals from the wave window
   
   
-f) How to start Quartus for RadioHDL
+g) How to start Quartus for RadioHDL
 
 To start Quartus for RadioHDL do:
 
@@ -179,7 +190,7 @@ projects are in the central $HDL_BUILD_DIR = $RADIOHDL/build/quartus:
   > unb2_rbf       unb1_minimal
   > unb2_sof       unb1_minimal 0
   
-g) How to start Modelsim for UNB
+h) How to start Modelsim for UNB
 
 GUI:
 
@@ -189,7 +200,7 @@ GUI:
 
 See the setup_unb.sh environment script and ASTRON_RP_1354_unb_minimal.pdf for more description.
 
-h) How to start Quartus for UNB
+i) How to start Quartus for UNB
 
 GUI:
 
@@ -428,16 +439,7 @@ entire eth library gets verified in one simulation.
 
 7) Synthesis in Quartus
 
-a) Compiling the Altera libraries for simulation with Modelsim
-
-The Altera verilog and vhdl libraries for the required FPGA device families can be compile using:
-
- > tools/quartus/run_altera_simlib_comp <tool target> <compilation output directory> <FPGA device family>
-
-This script must be used and not the tools/Launch simulation library compiler in the Quartus GUI, because
-the libraries have to be compiled with the 'vlib -type directory' option to be able to use 'mk all'.
-
-b) Creating the Quartus project files
+a) Creating the Quartus project files
 
 The quartus_config.py creates the Quartus qpf, qsf and or qip files for a design library.
 
-- 
GitLab