diff mbox series

doc: Document all D-specific configuration options.

Message ID 20200421072639.13898-1-ibuclaw@gdcproject.org
State New
Headers show
Series doc: Document all D-specific configuration options. | expand

Commit Message

Iain Buclaw April 21, 2020, 7:26 a.m. UTC 
Hi,

This patch adds documentation for --enable-libphobos-checking and
--with-libphobos-druntime-only options.

Does it read and explain clearly enough?

Regards
Iain.

gcc/ChangeLog:

	* doc/install.texi (D-Specific Options): Document
	--enable-libphobos-checking and --with-libphobos-druntime-only.
---
 gcc/doc/install.texi | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

Comments

Sandra Loosemore April 27, 2020, 5:15 a.m. UTC | #1 
On 4/21/20 1:26 AM, Iain Buclaw via Gcc-patches wrote:
> Hi,
> 
> This patch adds documentation for --enable-libphobos-checking and
> --with-libphobos-druntime-only options.
> 
> Does it read and explain clearly enough?
> 
> Regards
> Iain.
> 
> gcc/ChangeLog:
> 
> 	* doc/install.texi (D-Specific Options): Document
> 	--enable-libphobos-checking and --with-libphobos-druntime-only.

Looks good to me.

-Sandra
diff mbox series

Patch

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index bc5259d74c5..39ae0680260 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -2460,6 +2460,37 @@  default locations.
 The following options apply to the build of the D runtime library.
 
 @table @code
+@item --enable-libphobos-checking
+@itemx --disable-libphobos-checking
+@itemx --enable-libphobos-checking=@var{list}
+This option controls whether run-time checks and contracts are compiled into
+the D runtime library.  When the option is not specified, the library is built
+with @samp{release} checking.  When the option is specified without a
+@var{list}, the result is the same as @samp{--enable-libphobos-checking=yes}.
+Likewise, @samp{--disable-libphobos-checking} is equivalent to
+@samp{--enable-libphobos-checking=no}.
+
+The categories of checks available in @var{list} are @samp{yes} (compiles
+libphobos with @option{-fno-release}), @samp{no} (compiles libphobos with
+@option{-frelease}), @samp{all} (same as @samp{yes}), @samp{none} or
+@samp{release} (same as @samp{no}).
+
+Individual checks available in @var{list} are @samp{assert} (compiles libphobos
+with an extra option @option{-fassert}).
+
+@item --with-libphobos-druntime-only
+@itemx --with-libphobos-druntime-only=@var{choice}
+Specify whether to build only the core D runtime library (druntime), or both
+the core and standard library (phobos) into libphobos.  This is useful for
+targets that have full support in druntime, but no or incomplete support
+in phobos.  @var{choice} can be one of @samp{auto}, @samp{yes}, and @samp{no}
+where @samp{auto} is the default.
+
+When the option is not specified, the default choice @samp{auto} means that it
+is inferred whether the target has support for the phobos standard library.
+When the option is specified without a @var{choice},  the result is the same as
+@samp{--with-libphobos-druntime-only=yes}.
+
 @item --with-target-system-zlib
 Use installed @samp{zlib} rather than that included with GCC@.  This needs
 to be available for each multilib variant, unless configured with