Re: doc: extend --{enable,disable}-libsanitizer description [PR 105614]

[Rainer Orth <ro@CeBiTec.Uni-Bielefeld.DE>]

Hi Xi,

> A documentation improvement with no code change.  OK for trunk?
>
> -- >8 --
>
> We are receiving several reports that people are (mis)using
> --enable-libsanitizer option, which was not documented by GCC
> installation doc.  It forces to build libsanitizer even for unsupported
> targets, causing build failure.  Extend the --disable-libsanitizer
> description to also include --enable-libsanitizer, and warn about the
> possible consequences if it's enabled explicitly.

this behaviour isn't specific to libsanitizer at all: it probably
pertains to every target library using configure.tgt (libatomic,
libgomp, libitm, liboffloadmic, libphobos, libsanitizer, libvtv).  I
think it should be documented in a more generic way.

> gcc/ChangeLog:
>
> 	PR sanitizer/105614
> 	* doc/install.texi: Document --enable-libsanitizer and possible
> 	consequences.

It's better to specific which part of install.texi is affected.  In this
case, this would be

	* doc/install.texi (Configuration, --disable-libsanitizer): ...

Thanks.
	Rainer

-- 
-----------------------------------------------------------------------------
Rainer Orth, Center for Biotechnology, Bielefeld University