summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlistair Thomas <astavale@yahoo.co.uk>2021-05-08 12:43:43 +0100
committerRico Tzschichholz <ricotz@ubuntu.com>2021-05-08 17:35:42 +0200
commit4c63d52fb24b2b9847c5615c38f8e9f707bddd65 (patch)
tree1d0b1de56c68058d1f0dc87e2d08e02335299579 /doc
parent86e992f774bd706e386acd00210548e493b268ef (diff)
downloadvala-4c63d52fb24b2b9847c5615c38f8e9f707bddd65.tar.gz
doc: Update man page to include more information on profiles
Diffstat (limited to 'doc')
-rw-r--r--doc/valac.112
-rw-r--r--doc/valac.h2m12
-rw-r--r--doc/valadoc.12
3 files changed, 24 insertions, 2 deletions
diff --git a/doc/valac.1 b/doc/valac.1
index e132074e2..a1c0c3a9f 100644
--- a/doc/valac.1
+++ b/doc/valac.1
@@ -172,7 +172,17 @@ Write code tree to FILE
Keep temporary files
.TP
\fB\-\-profile\fR=\fI\,PROFILE\/\fR
-Use the given profile instead of the default, options are 'gobject' or 'posix'
+Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)
+.RS
+\fIgobject\fR enables GLib's GType runtime type system. The runtime environment
+will usually require libgobject and its small number of dependencies.
+\fIposix\fR removes the dependency on GLib and disables the runtime type
+system. The profile either generates alternative code or errors at compile time
+if a Vala language feature is used that requires the runtime type system. This
+is useful for writing code, for example, that targets microcontrollers or
+for extremely small system utilities or container images. The runtime
+environment will usually require a small subset of the ISO C standard library.
+.RE
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Do not print messages to the console
diff --git a/doc/valac.h2m b/doc/valac.h2m
index 70740811d..97995fa5d 100644
--- a/doc/valac.h2m
+++ b/doc/valac.h2m
@@ -23,6 +23,18 @@ or \fB--no-color\fR are declared then \fB--color\fR=\fIauto\fR is used where
output is colored when stderr is a terminal.
.RE
+/Minimum runtime dependency/
+.RS
+\fIgobject\fR enables GLib's GType runtime type system. The runtime environment
+will usually require libgobject and its small number of dependencies.
+\fIposix\fR removes the dependency on GLib and disables the runtime type
+system. The profile either generates alternative code or errors at compile time
+if a Vala language feature is used that requires the runtime type system. This
+is useful for writing code, for example, that targets microcontrollers or
+for extremely small system utilities or container images. The runtime
+environment will usually require a small subset of the ISO C standard library.
+.RE
+
/Enable support for ABI stability/
.RS
This changes the current behaviour to output public members of classes and
diff --git a/doc/valadoc.1 b/doc/valadoc.1
index a74d05e36..8e6411e2e 100644
--- a/doc/valadoc.1
+++ b/doc/valadoc.1
@@ -27,7 +27,7 @@ Base source directory
Define SYMBOL
.TP
\fB\-\-profile\fR=\fI\,PROFILE\/\fR
-Use the given profile instead of the default, options are 'gobject' or 'posix'
+Minimum runtime dependency: 'gobject' (default) or 'posix' (minimal libc)
.TP
\fB\-\-enable\-experimental\fR
Enable experimental features