diff options
Diffstat (limited to 'doc/references')
| -rw-r--r-- | doc/references/CommandReference.rst | 32 | ||||
| -rw-r--r-- | doc/references/ImplementationOfVHDL.rst | 12 |
2 files changed, 22 insertions, 22 deletions
diff --git a/doc/references/CommandReference.rst b/doc/references/CommandReference.rst index 2d7dc491a..3816afe42 100644 --- a/doc/references/CommandReference.rst +++ b/doc/references/CommandReference.rst @@ -20,7 +20,7 @@ There are a few GHDL commands which are seldom useful. .. index:: cmd help -Help [:samp:`-h`] +Help [``-h``] ----------------- .. option:: --help, -h @@ -35,7 +35,7 @@ for this later command are displayed:: .. index:: cmd display configuration -Display config [:samp:`--disp-config`] +Display config [``--disp-config``] -------------------------------------- .. option:: --disp-config <[options]> @@ -43,18 +43,18 @@ Display config [:samp:`--disp-config`] Display the program paths and options used by GHDL. This may be useful to track installation errors. .. index:: cmd display standard -.. index:: display :samp:`std.standard` +.. index:: display ``std.standard`` -Display standard [:samp:`--disp-standard`] +Display standard [``--disp-standard``] ------------------------------------------ .. option:: --disp-standard <[options]> -Display the :samp:`std.standard` package. +Display the ``std.standard`` package. .. index:: cmd version -Version [:samp:`--version`] +Version [``--version``] --------------------------- .. option:: --version, -v @@ -69,7 +69,7 @@ The following commands act on one or several files. These are not analyzed, ther .. index:: cmd file pretty printing .. index:: vhdl to html -Pretty print [:samp:`--pp-html`] +Pretty print [``--pp-html``] -------------------------------- .. option:: --pp-html <[options] file...> @@ -83,7 +83,7 @@ The style of the html file can be modified with the :option:`--format=` option: .. index:: cmd file find -Find [:samp:`-f`] +Find [``-f``] ----------------- .. option:: -f <file...> @@ -92,7 +92,7 @@ The files are scanned, parsed and the names of design units are displayed. Desig .. index:: cmd file chop -Chop [:samp:`--chop`] +Chop [``--chop``] --------------------- .. option:: --chop <files...> @@ -111,7 +111,7 @@ This command may be useful to split big files, if your computer has not enough m .. index:: cmd file lines -Lines [:samp:`--lines`] +Lines [``--lines``] ----------------------- .. option:: --lines <files...> @@ -123,7 +123,7 @@ GCC/LLVM only commands .. index:: cmd GCC/LLVM binding -Bind [:samp:`--bind`] +Bind [``--bind``] --------------------- .. option:: --bind <[options] primary_unit [secondary_unit]> @@ -132,7 +132,7 @@ Performs only the first stage of the elaboration command; the list of objects fi .. index:: cmd GCC/LLVM linking -Link [:samp:`--link`] +Link [``--link``] --------------------- .. option:: --link <[options] primary_unit [secondary_unit]> @@ -141,7 +141,7 @@ Performs only the second stage of the elaboration command: the executable is cre .. index:: cmd GCC/LLVM list link -List link [:samp:`--list-link`] +List link [``--list-link``] ------------------------------- .. option:: --list-link <primary_unit [secondary_unit]> @@ -167,15 +167,15 @@ This option is only useful during elaboration. .. option:: --GHDL1<=COMMAND> -Use :samp:`COMMAND` as the command name for the compiler. If :samp:`COMMAND` is not a path, then it is searched in the path. +Use ``COMMAND`` as the command name for the compiler. If ``COMMAND`` is not a path, then it is searched in the path. .. option:: --AS<=COMMAND> -Use :samp:`COMMAND` as the command name for the assembler. If :samp:`COMMAND` is not a path, then it is searched in the path. The default is :samp:`as`. +Use ``COMMAND`` as the command name for the assembler. If ``COMMAND`` is not a path, then it is searched in the path. The default is ``as``. .. option:: --LINK<=COMMAND> -Use :samp:`COMMAND` as the linker driver. If :samp:`COMMAND` is not a path, then it is searched in the path. The default is :samp:`gcc`. +Use ``COMMAND`` as the linker driver. If ``COMMAND`` is not a path, then it is searched in the path. The default is ``gcc``. Passing options to other programs ================================= diff --git a/doc/references/ImplementationOfVHDL.rst b/doc/references/ImplementationOfVHDL.rst index 8eaa04a81..66246608d 100644 --- a/doc/references/ImplementationOfVHDL.rst +++ b/doc/references/ImplementationOfVHDL.rst @@ -72,7 +72,7 @@ The latest version is 2008. Many features have been added, and GHDL doesn't implement all of them. You can select the VHDL standard expected by GHDL with the -:samp:`--std=VER` option, where :samp:`VER` is one of the left column of the +``--std=VER`` option, where ``VER`` is one of the left column of the table below: @@ -176,7 +176,7 @@ Library database ================ Each design unit analyzed is placed into a design library. By default, -the name of this design library is :samp:`work`; however, this can be +the name of this design library is ``work``; however, this can be changed with the :option:`--work=NAME` option of GHDL. To keep the list of design units in a design library, GHDL creates @@ -255,7 +255,7 @@ attribute. In this example, the `sin` function is imported: A subprogram is made foreign if the `foreign` attribute decorates it. This attribute is declared in the 1993 revision of the -:samp:`std.standard` package. Therefore, you cannot use this feature in +``std.standard`` package. Therefore, you cannot use this feature in VHDL 1987. The decoration is achieved through an attribute specification. The @@ -266,7 +266,7 @@ The value of the specification must be a locally static string. Even when a subprogram is foreign, its body must be present. However, since it won't be called, you can made it empty or simply but an assertion. -The value of the attribute must start with :samp:`VHPIDIRECT` (an +The value of the attribute must start with ``VHPIDIRECT`` (an upper-case keyword followed by one or more blanks). The linkage name of the subprogram follows. @@ -340,7 +340,7 @@ Starting a simulation from a foreign program -------------------------------------------- You may run your design from an external program. You just have to call -the :samp:`ghdl_main` function which can be defined: +the ``ghdl_main`` function which can be defined: in C: @@ -380,7 +380,7 @@ suppose there is only one design file, :file:`design.vhdl`. $ ghdl -a design.vhdl Then, bind your design. In this example, we suppose the entity at the -design apex is :samp:`design`. +design apex is ``design``. :: |