Re: [PATCH (pushed)] docs: document new --param=asan-kernel-mem-intrinsic-prefix

[Sandra Loosemore <sandra@codesourcery.com>]

[-- Attachment #1: Type: text/plain, Size: 1134 bytes --]

On 2/15/23 01:39, Martin Liška wrote:
> gcc/ChangeLog:
> 
> 	* doc/invoke.texi: Document --param=asan-kernel-mem-intrinsic-prefix.

I noticed this new text was missing Texinfo markup, so I've committed 
the attached followup patch.

I also wonder why this thing and several of the other asan things were 
added as parameters instead of options.  --param documentation is in the 
optimization options section, and the text before the table this new 
blurb was inserted into reads:

"In some places, GCC uses various constants to control the amount of
optimization that is done.  For example, GCC does not inline functions
that contain more than a certain number of instructions.  You can
control some of these constants on the command line using the
@option{--param} option. [...]"

I guess it is too late (at least for GCC 13) to change these things to 
be options and not parameters, but if we're now using --param for things 
other than avoiding hard-wired magic numbers in GCC's optimizers, we 
should probably move the --param documentation out of the optimization 
section and rewrite the description of what it's for.

-Sandra

[-- Attachment #2: asan-doc.patch --]
[-- Type: text/x-patch, Size: 1162 bytes --]

commit f56ed5b3bcb9d94c0169d56b8bf652c7b5aa9fd3
Author: Sandra Loosemore <sandra@codesourcery.com>
Date:   Sun Mar 12 03:41:11 2023 +0000

    Docs: Clean up description of asan-kernel-mem-intrinsic-prefix.
    
    gcc/ChangeLog:
            * doc/invoke.texi (Optimize Options):  Add markup to
            description of asan-kernel-mem-intrinsic-prefix, and clarify
            wording slightly.

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 3a6a97862b0..8d71d3d6ea5 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -15871,8 +15871,10 @@ E.g. to disable inline code use
 @option{--param asan-instrumentation-with-call-threshold=0}.
 
 @item asan-kernel-mem-intrinsic-prefix
-Prefix calls to memcpy, memset and memmove with __asan_ or __hwasan_
-for -fsanitize=kernel-address or -fsanitize=kernel-hwaddress.
+If nonzero, prefix calls to @code{memcpy}, @code{memset} and @code{memmove}
+with @samp{__asan_} or @samp{__hwasan_}
+for @option{-fsanitize=kernel-address} or @samp{-fsanitize=kernel-hwaddress},
+respectively.
 
 @item hwasan-instrument-stack
 Enable hwasan instrumentation of statically sized stack-allocated variables.