[DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Martin Liška]

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

Hello.

I would like to add a missing configure option.

Thanks,
Martin

[-- Attachment #2: 0001-Mention-enable-valgrind-annotations-in-install.texi.patch --]
[-- Type: text/x-patch, Size: 1106 bytes --]

From f828b34177908aebb1efab194f749bbdac0b1dbb Mon Sep 17 00:00:00 2001
From: marxin <mliska@suse.cz>
Date: Tue, 8 Dec 2015 16:54:43 +0100
Subject: [PATCH] Mention --enable-valgrind-annotations in install.texi

gcc/ChangeLog:

2015-12-08  Martin Liska  <mliska@suse.cz>

	* doc/install.texi (--enable-valgrind-annotations): Mention
	the configure option in configure page.
---
 gcc/doc/install.texi | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index 0b71bef..6cb2079 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -1584,6 +1584,11 @@ do a @samp{make -C gcc gnatlib_and_tools}.
 Specify that the run-time libraries for the various sanitizers should
 not be built.
 
+@item --enable-valgrind-annotations
+Specify that the compiler should interact with valgrind runtime, where
+selected invalid memory reads are marked as false positives and
+garbage collected memory is properly marked for proper interaction.
+
 @item --disable-libssp
 Specify that the run-time libraries for stack smashing protection
 should not be built.
-- 
2.6.3

Re: [DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Jeff Law]

On 12/08/2015 08:58 AM, Martin Liška wrote:
> Hello.
>
> I would like to add a missing configure option.
>
> Thanks,
> Martin
>
>
> 0001-Mention-enable-valgrind-annotations-in-install.texi.patch
>
>
>  From f828b34177908aebb1efab194f749bbdac0b1dbb Mon Sep 17 00:00:00 2001
> From: marxin<mliska@suse.cz>
> Date: Tue, 8 Dec 2015 16:54:43 +0100
> Subject: [PATCH] Mention --enable-valgrind-annotations in install.texi
>
> gcc/ChangeLog:
>
> 2015-12-08  Martin Liska<mliska@suse.cz>
>
> 	* doc/install.texi (--enable-valgrind-annotations): Mention
> 	the configure option in configure page.
OK.
jeff

Re: [DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Gerald Pfeifer]

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

On Tue, 8 Dec 2015, Martin Liška wrote:
> I would like to add a missing configure option.

I saw that Jeff approved while I was mulling over the patch,
but still have two questons:

1. Why did you sort this in where you did?  (It's not alphabetic.)

+Specify that the compiler should interact with valgrind runtime, where
+selected invalid memory reads are marked as false positives and
+garbage collected memory is properly marked for proper interaction.

2. "interact...for proper interaction" and "properly marked for
proper" feels a little confusing to me.  That is, I had to think
twice.  Any chance you can make this a little simpler to understand?

Gerald

Re: [DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Martin Liška]

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

On 12/09/2015 12:47 AM, Gerald Pfeifer wrote:
> On Tue, 8 Dec 2015, Martin Liška wrote:
>> I would like to add a missing configure option.
> 
> I saw that Jeff approved while I was mulling over the patch,
> but still have two questons:
> 
> 1. Why did you sort this in where you did?  (It's not alphabetic.)

Hi.

Well, it's not easy to find a place as the options are not well ordered :)
I tried to pick up a better place in v2.

> 
> +Specify that the compiler should interact with valgrind runtime, where
> +selected invalid memory reads are marked as false positives and
> +garbage collected memory is properly marked for proper interaction.
> 
> 2. "interact...for proper interaction" and "properly marked for
> proper" feels a little confusing to me.  That is, I had to think
> twice.  Any chance you can make this a little simpler to understand?

Sure, please read v2.

Martin

> 
> Gerald
> 


[-- Attachment #2: 0001-Mention-enable-valgrind-annotations-in-install.texi.patch --]
[-- Type: text/x-patch, Size: 1146 bytes --]

From 3531cab4de82bc0899c44d5cac19f3541027be8b Mon Sep 17 00:00:00 2001
From: marxin <mliska@suse.cz>
Date: Tue, 8 Dec 2015 16:54:43 +0100
Subject: [PATCH] Mention --enable-valgrind-annotations in install.texi

gcc/ChangeLog:

2015-12-08  Martin Liska  <mliska@suse.cz>

	* doc/install.texi (--enable-valgrind-annotations): Mention
	the configure option in configure page.
---
 gcc/doc/install.texi | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index 0b71bef..652b936 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -1748,6 +1748,12 @@ When this option is specified more detailed information on memory
 allocation is gathered.  This information is printed when using
 @option{-fmem-report}.
 
+@item --enable-valgrind-annotations
+Specify that the compiler should interact with valgrind runtime,
+where selected memory-related operations are marked as valid.
+There operations are safe and should not become a candidate
+of an undefined behavior.
+
 @item --enable-nls
 @itemx --disable-nls
 The @option{--enable-nls} option enables Native Language Support (NLS),
-- 
2.6.3

Re: [DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Markus Trippelsdorf]

On 2015.12.09 at 10:33 +0100, Martin Liška wrote:
> On 12/09/2015 12:47 AM, Gerald Pfeifer wrote:
> > On Tue, 8 Dec 2015, Martin Liška wrote:
> >> I would like to add a missing configure option.
> > 
> > +Specify that the compiler should interact with valgrind runtime, where
> > +selected invalid memory reads are marked as false positives and
> > +garbage collected memory is properly marked for proper interaction.
> > 
> > 2. "interact...for proper interaction" and "properly marked for
> > proper" feels a little confusing to me.  That is, I had to think
> > twice.  Any chance you can make this a little simpler to understand?
> 
> Sure, please read v2.
> 
> +@item --enable-valgrind-annotations
> +Specify that the compiler should interact with valgrind runtime,
> +where selected memory-related operations are marked as valid.
> +There operations are safe and should not become a candidate
> +of an undefined behavior.

Sorry, but this is simply awful ;-). How about:

Mark selected memory related operations in the compiler when run under
valgrind to suppress false positives.


-- 
Markus

Re: [DOC, PATCH] Mention --enable-valgrind-annotations in install.texi

[Martin Liška]

On 12/09/2015 11:01 AM, Markus Trippelsdorf wrote:
> Sorry, but this is simply awful ;-). How about:
> 
> Mark selected memory related operations in the compiler when run under
> valgrind to suppress false positives.

Hi.

I forgot to install the patch, following Markus' correction, installed as r233735.

Martin