Re: [doc patch] remove hyphen from side-effect
On 04/09/2018 06:37 PM, Sandra Loosemore wrote: On 04/09/2018 05:58 PM, Martin Sebor wrote: Ping: I will go ahead and commit this patch sometime this week unless I hear objections: https://gcc.gnu.org/ml/gcc-patches/2018-04/msg00036.html This patch is mostly OK, except for these hunks: Index: gcc/doc/invoke.texi === --- gcc/doc/invoke.texi(revision 259017) +++ gcc/doc/invoke.texi(working copy) @@ -8710,7 +8710,7 @@ default at @option{-O} and higher. @item -ftree-builtin-call-dce @opindex ftree-builtin-call-dce Perform conditional dead code elimination (DCE) for calls to built-in functions -that may set @code{errno} but are otherwise side-effect free. This flag is +that may set @code{errno} but are otherwise side effect free. This flag is enabled by default at @option{-O2} and higher if @option{-Os} is not also specified. s/side-effect free/free of side effects/ Sure, that's better. @@ -14229,7 +14229,7 @@ not overridden} will do. This option is implicitly passed to the compiler for the second compilation requested by @option{-fcompare-debug}, along with options to silence warnings, and omitting other options that would cause -side-effect compiler outputs to files or to the standard output. Dump +side effect compiler outputs to files or to the standard output. Dump files and preserved temporary files are renamed so as to contain the @code{.gk} additional extension during the second compilation, to avoid overwriting those generated by the first. This is impossible to parse either with or without the hyphen. How about rewriting the end of that sentence as ...that would cause the compiler to produce output to files or to standard output as a side effect. ?? Yes, that reads much better. @@ -3496,7 +3496,7 @@ instructions. @cindex RTL predecrement @cindex RTL postdecrement -Six special side-effect expression codes appear as memory addresses. +Six special side effect expression codes appear as memory addresses. @table @code @findex pre_dec This should either remain hyphenated (adjective phrase immediately before the noun), or rewritten as something like Six special expression codes represent memory addresses with side effects. I agree that sounds better as well. Index: gcc/doc/tm.texi.in === --- gcc/doc/tm.texi.in(revision 259017) +++ gcc/doc/tm.texi.in(working copy) @@ -3967,7 +3967,7 @@ pre-decrement, post-increment, or post-decrement a @defmac HAVE_PRE_MODIFY_DISP @defmacx HAVE_POST_MODIFY_DISP A C expression that is nonzero if the machine supports pre- or -post-address side-effect generation involving constants other than +post-address side effect generation involving constants other than the size of the memory operand. @end defmac @@ -3974,7 +3974,7 @@ the size of the memory operand. @defmac HAVE_PRE_MODIFY_REG @defmacx HAVE_POST_MODIFY_REG A C expression that is nonzero if the machine supports pre- or -post-address side-effect generation involving a register displacement. +post-address side effect generation involving a register displacement. @end defmac @defmac CONSTANT_ADDRESS_P (@var{x}) I think both of these should also remain hyphenated (adjective phrase immediately before the modified noun). Okay. I committed the result in r259287. Martin
Re: [doc patch] remove hyphen from side-effect
On 04/09/2018 05:58 PM, Martin Sebor wrote: Ping: I will go ahead and commit this patch sometime this week unless I hear objections: https://gcc.gnu.org/ml/gcc-patches/2018-04/msg00036.html This patch is mostly OK, except for these hunks: Index: gcc/doc/invoke.texi === --- gcc/doc/invoke.texi (revision 259017) +++ gcc/doc/invoke.texi (working copy) @@ -8710,7 +8710,7 @@ default at @option{-O} and higher. @item -ftree-builtin-call-dce @opindex ftree-builtin-call-dce Perform conditional dead code elimination (DCE) for calls to built-in functions -that may set @code{errno} but are otherwise side-effect free. This flag is +that may set @code{errno} but are otherwise side effect free. This flag is enabled by default at @option{-O2} and higher if @option{-Os} is not also specified. s/side-effect free/free of side effects/ @@ -14229,7 +14229,7 @@ not overridden} will do. This option is implicitly passed to the compiler for the second compilation requested by @option{-fcompare-debug}, along with options to silence warnings, and omitting other options that would cause -side-effect compiler outputs to files or to the standard output. Dump +side effect compiler outputs to files or to the standard output. Dump files and preserved temporary files are renamed so as to contain the @code{.gk} additional extension during the second compilation, to avoid overwriting those generated by the first. This is impossible to parse either with or without the hyphen. How about rewriting the end of that sentence as ...that would cause the compiler to produce output to files or to standard output as a side effect. ?? @@ -3496,7 +3496,7 @@ instructions. @cindex RTL predecrement @cindex RTL postdecrement -Six special side-effect expression codes appear as memory addresses. +Six special side effect expression codes appear as memory addresses. @table @code @findex pre_dec This should either remain hyphenated (adjective phrase immediately before the noun), or rewritten as something like Six special expression codes represent memory addresses with side effects. Index: gcc/doc/tm.texi.in === --- gcc/doc/tm.texi.in (revision 259017) +++ gcc/doc/tm.texi.in (working copy) @@ -3967,7 +3967,7 @@ pre-decrement, post-increment, or post-decrement a @defmac HAVE_PRE_MODIFY_DISP @defmacx HAVE_POST_MODIFY_DISP A C expression that is nonzero if the machine supports pre- or -post-address side-effect generation involving constants other than +post-address side effect generation involving constants other than the size of the memory operand. @end defmac @@ -3974,7 +3974,7 @@ the size of the memory operand. @defmac HAVE_PRE_MODIFY_REG @defmacx HAVE_POST_MODIFY_REG A C expression that is nonzero if the machine supports pre- or -post-address side-effect generation involving a register displacement. +post-address side effect generation involving a register displacement. @end defmac @defmac CONSTANT_ADDRESS_P (@var{x}) I think both of these should also remain hyphenated (adjective phrase immediately before the modified noun). -Sandra
Re: [doc patch] remove hyphen from side-effect
Ping: I will go ahead and commit this patch sometime this week unless I hear objections: https://gcc.gnu.org/ml/gcc-patches/2018-04/msg00036.html Martin On 04/02/2018 03:55 PM, Martin Sebor wrote: Attached is a patch to remove the hyphen from uses of side-effect in the manual as per the comment in: https://gcc.gnu.org/ml/gcc-patches/2018-04/msg00021.html Although both forms are common, "side effect" (without the hyphen) is more prevalent in current English and I think it's better to be consistent than to have to rehash this question each time someone happens to copy the less common form from existing text. https://english.stackexchange.com/questions/889/when-should-compound-words-be-written-as-one-word-with-hyphens-or-with-spaces Martin