diff options
author | umarcor <38422348+umarcor@users.noreply.github.com> | 2020-05-03 11:15:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-03 11:15:30 +0200 |
commit | 84b548ddb8dd089f7953bbda0fa8db424f02ef09 (patch) | |
tree | ee743b2642a0da4877e230fc72dad29d6fb6d017 /doc/using | |
parent | c590d31a4d181a3da096b52b209e4b0cc6add63a (diff) | |
download | ghdl-84b548ddb8dd089f7953bbda0fa8db424f02ef09.tar.gz ghdl-84b548ddb8dd089f7953bbda0fa8db424f02ef09.tar.bz2 ghdl-84b548ddb8dd089f7953bbda0fa8db424f02ef09.zip |
Document and use --vpi-library-dir-unix (#1279)
* testsuite: use '--vpi-library-dir-unix' in 'add_vpi_path'
* doc: add '--vpi-library-dir-unix', remove redundant headers
Diffstat (limited to 'doc/using')
-rw-r--r-- | doc/using/InvokingGHDL.rst | 51 |
1 files changed, 8 insertions, 43 deletions
diff --git a/doc/using/InvokingGHDL.rst b/doc/using/InvokingGHDL.rst index 1857fccfc..9a548c992 100644 --- a/doc/using/InvokingGHDL.rst +++ b/doc/using/InvokingGHDL.rst @@ -498,9 +498,6 @@ Furthermore, GHDL provides a few commands which act on a library: .. index:: cmd library directory -Directory [``--dir``] ---------------------- - .. option:: --dir <[options] [libs]> Displays the content of the design libraries (by default the ``work`` library). All options are allowed, but only a few are meaningful: :option:`--work`, :option:`--workdir` and :option:`--std`. @@ -510,9 +507,6 @@ Displays the content of the design libraries (by default the ``work`` library). .. _Clean:command: -Clean [``--clean``] -------------------- - .. option:: --clean <[options]> Try to remove any object, executable or temporary file it could have created. Source files are not removed. The library is kept. @@ -522,9 +516,6 @@ Try to remove any object, executable or temporary file it could have created. So .. _Remove:command: -Remove [``--remove``] ---------------------- - .. option:: --remove <[options]> Acts like the clean command but removes the library too. Note that after removing a design library, the files are not @@ -533,9 +524,6 @@ known anymore by GHDL. .. index:: cmd library copy -Copy [``--copy``] ------------------ - .. option:: --copy <--work=name [options]> Make a local copy of an existing library. This is very useful if you want to add units to the ``ieee`` library: @@ -556,9 +544,6 @@ command before its execution. .. index:: cmd VPI compile -compile [``--vpi-compile``] ---------------------------- - .. option:: --vpi-compile <command> Add an include path to the command and execute it:: @@ -569,21 +554,13 @@ This will execute:: command -Ixxx/include -For example:: - - ghdl --vpi-compile gcc -c vpi1.c +For example, ``ghdl --vpi-compile gcc -c vpi1.c`` executes ``gcc -c vpi1.c -fPIC -Ixxx/include``. -executes:: - - gcc -c vpi1.c -fPIC -Ixxx/include .. _VPI_link_command: .. index:: cmd VPI link -link [``--vpi-link``] ---------------------- - .. option:: --vpi-link <command> Add a library path and name to the command and execute it:: @@ -594,53 +571,41 @@ This will execute:: command -Lxxx/lib -lghdlvpi -For example:: - - ghdl --vpi-link gcc -o vpi1.vpi vpi1.o - -executes:: - - gcc -o vpi1.vpi vpi1.o --shared -Lxxx/lib -lghdlvpi +For example, ``ghdl --vpi-link gcc -o vpi1.vpi vpi1.o`` executes ``gcc -o vpi1.vpi vpi1.o --shared -Lxxx/lib -lghdlvpi``. .. _VPI_cflags_command: .. index:: cmd VPI cflags -cflags [``--vpi-cflags``] -------------------------- - .. option:: --vpi-cflags Display flags added by :option:`--vpi-compile`. -.. index:: cmd VPI ldflags -ldflags [``--vpi-ldflags``] ---------------------------- +.. index:: cmd VPI ldflags .. option:: --vpi-ldflags Display flags added by :option:`--vpi-link`. -.. index:: cmd VPI include dir -include dir [``--vpi-include-dir``] ------------------------------------ +.. index:: cmd VPI include dir .. option:: --vpi-include-dir Display the include directory added by the compile flags. -.. index:: cmd VPI library dir -library dir [``--vpi-library-dir``] ------------------------------------ +.. index:: cmd VPI library dir .. option:: --vpi-library-dir Display the library directory added by the link flags. +.. option:: --vpi-library-dir-unix + +Display the library directory added by the link flags, forcing UNIX syntax. .. _ieee_library_pitfalls: |