diff options
| author | eine <eine@users.noreply.github.com> | 2020-05-27 08:13:45 +0200 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2020-05-27 08:22:54 +0200 |
| commit | 91bf00df6205c43048d8e9d309d5b8029a57b2fd (patch) | |
| tree | 141b077dcc414810019ea121a7a4964ae75ea58a /doc | |
| parent | df0b29650e93b3f1dd65517d26e6419657d2d5b6 (diff) | |
| download | ghdl-91bf00df6205c43048d8e9d309d5b8029a57b2fd.tar.gz ghdl-91bf00df6205c43048d8e9d309d5b8029a57b2fd.tar.bz2 ghdl-91bf00df6205c43048d8e9d309d5b8029a57b2fd.zip | |
doc: move --file-to-xml to 'Misc commands'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/using/CommandReference.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/using/CommandReference.rst b/doc/using/CommandReference.rst index 6284db18b..8b9209093 100644 --- a/doc/using/CommandReference.rst +++ b/doc/using/CommandReference.rst @@ -113,6 +113,19 @@ Lines [``--lines``] Display on the standard output lines of files preceded by line number. +.. index:: cmd XML generation + +XML tree generation [``--file-to-xml``] +--------------------------------------- + +.. option:: --file-to-xml + + Outputs an XML representation of the decorated syntax tree for the input file and its dependencies. It can be used for VHDL tooling using semantic information, like style checkers, documentation extraction, complexity estimation, etc. + +.. WARNING:: + * The AST slightly changes from time to time (particularly when new nodes are added for new language features), so be liberal in what is allowed by your tool. Also, the XML can be quite large so consider it only during prototyping. + * Note that at this time there is no XML dump of the elaborated design. + .. _gccllvm-only-programs: GCC/LLVM only commands @@ -154,19 +167,6 @@ This command may be used only after a bind command. GHDL displays all the files * Filter the output of ``--list-link`` with e.g. ``sed``. * Provide an additional non-anonymous version script: ``-Wl,-Wl,--version-script=file.ver``. -.. index:: cmd XML generation - -XML tree generation [``--file-to-xml``] ---------------------------------------- - -.. option:: --file-to-xml - - Outputs an XML representation of the decorated syntax tree for the input file and its dependencies. It can be used for VHDL tooling using semantic information, like style checkers, documentation extraction, complexity estimation, etc. - -.. WARNING:: - * The AST slightly changes from time to time (particularly when new nodes are added for new language features), so be liberal in what is allowed by your tool. Also, the XML can be quite large so consider it only during prototyping. - * Note that at this time there is no XML dump of the elaborated design. - Options ======= |