aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2014-05-29 13:40:25 +0200
committerTristan Gingold <tgingold@free.fr>2014-05-29 13:40:25 +0200
commit8ee27274d6f04b2424fa70569fedf405de9da64a (patch)
tree8b9d89630fd78b023e5cd0e0fadec59944fadce3 /doc
parent00dd8928ce4ab9f71713adcf66fa063f0e5ff1db (diff)
downloadghdl-8ee27274d6f04b2424fa70569fedf405de9da64a.tar.gz
ghdl-8ee27274d6f04b2424fa70569fedf405de9da64a.tar.bz2
ghdl-8ee27274d6f04b2424fa70569fedf405de9da64a.zip
doc: add an example for --work (YG).
Diffstat (limited to 'doc')
-rw-r--r--doc/ghdl.texi22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/ghdl.texi b/doc/ghdl.texi
index 36df245d8..831d0a104 100644
--- a/doc/ghdl.texi
+++ b/doc/ghdl.texi
@@ -1169,6 +1169,7 @@ GHDL has a few commands which act on a library.
* Clean command::
* Remove command::
* Copy command::
+* Create a Library::
@end menu
@node Directory command, Clean command, Library commands, Library commands
@@ -1217,7 +1218,7 @@ There is no short command line form for this option to prevent accidental
clean up. Note that after removing a design library, the files are not
known anymore by GHDL.
-@node Copy command, , Remove command, Library commands
+@node Copy command, Create a Library, Remove command, Library commands
@subsection Copy command
@cindex copying library
@cindex @option{--copy} command
@@ -1234,6 +1235,25 @@ $ ghdl --copy --work=ieee --ieee=synopsys
$ ghdl -a --work=ieee numeric_unsigned.vhd
@end example
+@node Create a Library, , Copy command, Library commands
+@subsection Create a Library
+@cindex create your own library
+
+A new library is created by compiling entities (packages etc.) into it.
+
+@smallexample
+ghdl -a --work=my_custom_lib my_file.vhd
+@end smallexample
+
+A library's source code is usually stored and compiled into its own directory,
+that you specify with the --workdir option.
+
+@smallexample
+ghdl -a --work=my_custom_lib --workdir=my_custom_libdir my_custom_lib_srcdir/my_file.vhd
+@end smallexample
+
+See also the -PPATH command line option.
+
@node Cross-reference command, File commands, Library commands, Invoking GHDL
@comment node-name, next, previous, up
@section Cross-reference command