From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 75362 invoked by alias); 2 Apr 2018 21:55:29 -0000 Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Archive: List-Post: List-Help: Sender: gcc-patches-owner@gcc.gnu.org Received: (qmail 74937 invoked by uid 89); 2 Apr 2018 21:55:28 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-16.1 required=5.0 tests=BAYES_00,FREEMAIL_FROM,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,KAM_ASCII_DIVIDERS,KAM_SHORT,RCVD_IN_DNSWL_NONE,SPF_PASS autolearn=ham version=3.3.2 spammy=Frame, English X-HELO: mail-oi0-f42.google.com Received: from mail-oi0-f42.google.com (HELO mail-oi0-f42.google.com) (209.85.218.42) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 02 Apr 2018 21:55:25 +0000 Received: by mail-oi0-f42.google.com with SMTP id x9-v6so14160289oig.7 for ; Mon, 02 Apr 2018 14:55:24 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:to:from:subject:message-id:date:user-agent :mime-version; bh=e4p6M1wiuViSo8XGu5gCcj30rMQNS3EhhYOWfByPrM4=; b=XhJp3AiqiAyOStm32zqACRfPj1uhKQohkge9cGDmZh/rrgelV0IWGkZko+Q19UTnQL OlvBRYSpVCt0txBl40TWkVTw+s+ioQ1k/nQLPfoaD5z78HMQ6gi2qv8XOSWtyqmSQvhE rF6FjWTIHggrVC25dqx2mPYg4s8AIQFkRZCMKs+VT1PGM3mxNf80FgWkdu+hVT7Yngkx KwUnY7CBMMZcuf4Ft9i86UxSm3FrYH9ufK2GEgx31+xbqQ5erPLQnIFqLt8F1Up4wTV/ QJF4EmZGmoWTp1OkqC6VKSRpAN+eixQFXUyxMz9aEd+0XlFbAp+PCyYZ0TISCtcD5qnt tnsg== X-Gm-Message-State: ALQs6tDO1R4Dln1f98ORFZFfTg+ajoXbT/NLqdE4A8hH7kATMjs+pwlX YF637SsC2VEboKxTT4A7EU86EA== X-Google-Smtp-Source: AIpwx4/jh8haxnnavN5ADfH5Yi7tOA+8p5XzC6USodf4jQ7L7yMLkAEYKJhrhzSIFOQR+fy7DXmUPg== X-Received: by 2002:aca:405:: with SMTP id 5-v6mr6348510oie.9.1522706123071; Mon, 02 Apr 2018 14:55:23 -0700 (PDT) Received: from localhost.localdomain (174-16-100-37.hlrn.qwest.net. [174.16.100.37]) by smtp.gmail.com with ESMTPSA id b17-v6sm690118otf.38.2018.04.02.14.55.21 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 02 Apr 2018 14:55:21 -0700 (PDT) To: Sandra Loosemore , Gcc Patch List From: Martin Sebor Subject: [doc patch] remove hyphen from side-effect Message-ID: <67f20d0e-954d-509e-83aa-314dd0f2ba29@gmail.com> Date: Mon, 02 Apr 2018 21:55:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------43A204433F3AFE85780A387C" X-IsSubscribed: yes X-SW-Source: 2018-04/txt/msg00036.txt.bz2 This is a multi-part message in MIME format. --------------43A204433F3AFE85780A387C Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-length: 557 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 --------------43A204433F3AFE85780A387C Content-Type: text/x-patch; name="gcc-doc-side-effect.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="gcc-doc-side-effect.diff" Content-length: 18058 gcc/ChangeLog: * doc/cppopts.texi: Use "side effect" instead of side-effect. * doc/extend.texi: Same. * doc/generic.texi: Same. * doc/implement-c.texi: Same. * doc/invoke.texi: Same. * doc/md.texi: Same. * doc/rtl.texi: Same. * doc/tm.texi: Same. * doc/tm.texi.in: Same. * doc/tree-ssa.texi: Same. Index: gcc/doc/cppopts.texi =================================================================== --- gcc/doc/cppopts.texi (revision 259017) +++ gcc/doc/cppopts.texi (working copy) @@ -200,7 +200,7 @@ If @option{-MD} is used in conjunction with @optio is understood to specify a target object file. Since @option{-E} is not implied, @option{-MD} can be used to generate -a dependency output file as a side-effect of the compilation process. +a dependency output file as a side effect of the compilation process. @item -MMD @opindex MMD @@ -403,7 +403,7 @@ Do not discard comments, including during macro ex like @option{-C}, except that comments contained within macros are also passed through to the output file where the macro is expanded. -In addition to the side-effects of the @option{-C} option, the +In addition to the side effects of the @option{-C} option, the @option{-CC} option causes all C++-style comments inside a macro to be converted to C-style comments. This is to prevent later use of that macro from inadvertently commenting out the remainder of Index: gcc/doc/extend.texi =================================================================== --- gcc/doc/extend.texi (revision 259017) +++ gcc/doc/extend.texi (working copy) @@ -2050,7 +2050,7 @@ int widths[] = @{ [0 ... 9] = 1, [10 ... 99] = 2, @end smallexample @noindent -If the value in it has side-effects, the side-effects happen only once, +If the value in it has side effects, the side effects happen only once, not for each initialized field by the range initializer. @noindent @@ -2147,7 +2147,7 @@ struct point ptarray[10] = @{ [2].y = yv2, [2].x = @noindent If the same field is initialized multiple times, it has the value from the last initialization. If any such overridden initialization has -side-effect, it is unspecified whether the side-effect happens or not. +side effect, it is unspecified whether the side effect happens or not. Currently, GCC discards them and issues a warning. @node Case Ranges @@ -3024,7 +3024,7 @@ This function attribute prevents a function from b inlining. @c Don't enumerate the optimizations by name here; we try to be @c future-compatible with this mechanism. -If the function does not have side-effects, there are optimizations +If the function does not have side effects, there are optimizations other than inlining that cause function calls to be optimized away, although the function call is live. To keep such calls from being optimized away, put @@ -3034,7 +3034,7 @@ asm (""); @noindent (@pxref{Extended Asm}) in the called function, to serve as a special -side-effect. +side effect. @item noipa @cindex @code{noipa} function attribute @@ -10658,7 +10658,7 @@ The built-in functions promote the first two opera and perform addition on those promoted operands. The result is then cast to the type of the third argument. If the cast result is equal to the infinite precision result, the built-in functions return false, otherwise they return true. -The value of the third argument is ignored, just the side-effects in the third argument +The value of the third argument is ignored, just the side effects in the third argument are evaluated, and no integral argument promotions are performed on the last argument. If the third argument is a bit-field, the type used for the result cast has the precision and signedness of the given bit-field, rather than precision and signedness @@ -10754,7 +10754,7 @@ a limited extent, they can be used without optimiz is a built-in construct that returns a constant number of bytes from @var{ptr} to the end of the object @var{ptr} pointer points to (if known at compile time). @code{__builtin_object_size} never evaluates -its arguments for side-effects. If there are any side-effects in them, it +its arguments for side effects. If there are any side effects in them, it returns @code{(size_t) -1} for @var{type} 0 or 1 and @code{(size_t) 0} for @var{type} 2 or 3. If there are multiple objects @var{ptr} can point to and all of them are known at compile time, the returned number @@ -11773,7 +11773,7 @@ This built-in function is analogous to the @samp{? except that the expression returned has its type unaltered by promotion rules. Also, the built-in function does not evaluate the expression that is not chosen. For example, if @var{const_exp} evaluates to true, -@var{exp2} is not evaluated even if it has side-effects. +@var{exp2} is not evaluated even if it has side effects. This built-in function can return an lvalue if the chosen argument is an lvalue. @@ -21832,7 +21832,7 @@ Returns @code{_XBEGIN_STARTED} when the transactio started successfully (note this is not 0, so the constant has to be explicitly tested). -If the transaction aborts, all side-effects +If the transaction aborts, all side effects are undone and an abort code encoded as a bit mask is returned. The following macros are defined: @@ -21859,7 +21859,7 @@ fallback path. @deftypefn {RTM Function} {void} _xend () Commit the current transaction. When no transaction is active this faults. -All memory side-effects of the transaction become visible +All memory side effects of the transaction become visible to other threads in an atomic manner. @end deftypefn Index: gcc/doc/generic.texi =================================================================== --- gcc/doc/generic.texi (revision 259017) +++ gcc/doc/generic.texi (working copy) @@ -1644,10 +1644,10 @@ represented conveniently as @code{(i >= 0 && i < 1 As a GNU extension, the C language front-ends allow the second operand of the @code{?:} operator may be omitted in the source. For example, @code{x ? : 3} is equivalent to @code{x ? x : 3}, -assuming that @code{x} is an expression without side-effects. +assuming that @code{x} is an expression without side effects. In the tree representation, however, the second operand is always present, possibly protected by @code{SAVE_EXPR} if the first -argument does cause side-effects. +argument does cause side effects. @item CALL_EXPR These nodes are used to represent calls to functions, including @@ -1732,10 +1732,10 @@ by the @code{COMPOUND_LITERAL_EXPR_DECL} macro. @item SAVE_EXPR A @code{SAVE_EXPR} represents an expression (possibly involving -side-effects) that is used more than once. The side-effects should +side effects) that is used more than once. The side effects should occur only the first time the expression is evaluated. Subsequent uses should just reuse the computed value. The first operand to the -@code{SAVE_EXPR} is the expression to evaluate. The side-effects should +@code{SAVE_EXPR} is the expression to evaluate. The side effects should be executed where the @code{SAVE_EXPR} is first encountered in a depth-first preorder traversal of the expression tree. @@ -2222,9 +2222,9 @@ of the form @code{VAR @{<,>,<=,>=@} N2}. Operand @code{OMP_FOR_INCR} is the loop index increment of the form @code{VAR @{+=,-=@} INCR}. -Operand @code{OMP_FOR_PRE_BODY} contains side-effect code from +Operand @code{OMP_FOR_PRE_BODY} contains side effect code from operands @code{OMP_FOR_INIT}, @code{OMP_FOR_COND} and -@code{OMP_FOR_INC}. These side-effects are part of the +@code{OMP_FOR_INC}. These side effects are part of the @code{OMP_FOR} block but must be evaluated before the start of loop body. @@ -2233,7 +2233,7 @@ which is implicitly private to each thread. Bound @code{N1} and @code{N2} and the increment expression @code{INCR} are required to be loop invariant integer expressions that are evaluated without any synchronization. The -evaluation order, frequency of evaluation and side-effects are +evaluation order, frequency of evaluation and side effects are unspecified by the standard. @item OMP_SECTIONS Index: gcc/doc/implement-c.texi =================================================================== --- gcc/doc/implement-c.texi (revision 259017) +++ gcc/doc/implement-c.texi (working copy) @@ -567,7 +567,7 @@ volatile int *src = @var{somevalue}; According to the C standard, such an expression is an rvalue whose type is the unqualified version of its original type, i.e. @code{int}. Whether GCC interprets this as a read of the volatile object being pointed to or -only as a request to evaluate the expression for its side-effects depends +only as a request to evaluate the expression for its side effects depends on this type. If it is a scalar type, or on most targets an aggregate type whose only @@ -574,7 +574,7 @@ If it is a scalar type, or on most targets an aggr member object is of a scalar type, or a union type whose member objects are of scalar types, the expression is interpreted by GCC as a read of the volatile object; in the other cases, the expression is only evaluated -for its side-effects. +for its side effects. @end itemize 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. @@ -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. @@ -20970,7 +20970,7 @@ Work around certain SB-1 CPU core errata. @item -mr10k-cache-barrier=@var{setting} @opindex mr10k-cache-barrier Specify whether GCC should insert cache barriers to avoid the -side-effects of speculation on R10K processors. +side effects of speculation on R10K processors. In common with many processors, the R10K tries to predict the outcome of a conditional branch and speculatively executes instructions from Index: gcc/doc/md.texi =================================================================== --- gcc/doc/md.texi (revision 259017) +++ gcc/doc/md.texi (working copy) @@ -867,7 +867,7 @@ hardware's requirements explicitly. @defun push_operand This predicate allows a memory reference suitable for pushing a value onto the stack. This will be a @code{MEM} which refers to -@code{stack_pointer_rtx}, with a side-effect in its address expression +@code{stack_pointer_rtx}, with a side effect in its address expression (@pxref{Incdec}); which one is determined by the @code{STACK_PUSH_CODE} macro (@pxref{Frame Layout}). @end defun @@ -875,7 +875,7 @@ onto the stack. This will be a @code{MEM} which r @defun pop_operand This predicate allows a memory reference suitable for popping a value off the stack. Again, this will be a @code{MEM} referring to -@code{stack_pointer_rtx}, with a side-effect in its address +@code{stack_pointer_rtx}, with a side effect in its address expression. However, this time @code{STACK_POP_CODE} is expected. @end defun @@ -1091,7 +1091,7 @@ operand may be an immediate constant, and which po have. Constraints can also require two operands to match. Side-effects aren't allowed in operands of inline @code{asm}, unless @samp{<} or @samp{>} constraints are used, because there is no guarantee -that the side-effects will happen exactly once in an instruction that can update +that the side effects will happen exactly once in an instruction that can update the addressing register. @ifset INTERNALS @@ -1172,9 +1172,9 @@ would fit the @samp{m} constraint but not the @sam A memory operand with autodecrement addressing (either predecrement or postdecrement) is allowed. In inline @code{asm} this constraint is only allowed if the operand is used exactly once in an instruction that can -handle the side-effects. Not using an operand with @samp{<} in constraint +handle the side effects. Not using an operand with @samp{<} in constraint string in the inline @code{asm} pattern at all or using it in multiple -instructions isn't valid, because the side-effects wouldn't be performed +instructions isn't valid, because the side effects wouldn't be performed or would be performed more than once. Furthermore, on some targets the operand with @samp{<} in constraint string must be accompanied by special instruction suffixes like @code{%U0} instruction suffix on PowerPC Index: gcc/doc/rtl.texi =================================================================== --- gcc/doc/rtl.texi (revision 259017) +++ gcc/doc/rtl.texi (working copy) @@ -34,7 +34,7 @@ form uses nested parentheses to indicate the point * Conversions:: Extending, truncating, floating or fixing. * RTL Declarations:: Declaring volatility, constancy, etc. * Side Effects:: Expressions for storing in registers, etc. -* Incdec:: Embedded side-effects for autoincrement addressing. +* Incdec:: Embedded side effects for autoincrement addressing. * Assembler:: Representing @code{asm} with operands. * Debug Information:: Expressions representing debugging information. * Insns:: Expression types for entire insns. @@ -3352,7 +3352,7 @@ side effect expressions---expressions of code @cod @code{return}, @code{simple_return}, @code{clobber} or @code{use}. ``In parallel'' means that first all the values used in the individual -side-effects are computed, and second all the actual side-effects are +side effects are computed, and second all the actual side effects are performed. For example, @smallexample @@ -3398,8 +3398,8 @@ any, must deal with such insns if you define any p @item (cond_exec [@var{cond} @var{expr}]) Represents a conditionally executed expression. The @var{expr} is executed only if the @var{cond} is nonzero. The @var{cond} expression -must not have side-effects, but the @var{expr} may very well have -side-effects. +must not have side effects, but the @var{expr} may very well have +side effects. @findex sequence @item (sequence [@var{insns} @dots{}]) @@ -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 @@ -4499,7 +4499,7 @@ vector at all. No RTL object appears in more than one place in the RTL structure except as described above. Many passes of the compiler rely on this by assuming that they can modify RTL objects in place without unwanted -side-effects on other insns. +side effects on other insns. @findex unshare_all_rtl @item Index: gcc/doc/tm.texi =================================================================== --- gcc/doc/tm.texi (revision 259017) +++ gcc/doc/tm.texi (working copy) @@ -5535,7 +5535,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 @@ -5542,7 +5542,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}) 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}) Index: gcc/doc/tree-ssa.texi =================================================================== --- gcc/doc/tree-ssa.texi (revision 259017) +++ gcc/doc/tree-ssa.texi (working copy) @@ -25,7 +25,7 @@ etc). Much like GENERIC, GIMPLE is a language ind representation. However, it differs from GENERIC in that the GIMPLE grammar is more restrictive: expressions contain no more than 3 operands (except function calls), it has no control flow structures -and expressions with side-effects are only allowed on the right hand +and expressions with side effects are only allowed on the right hand side of assignments. See the chapter describing GENERIC and GIMPLE for more details. --------------43A204433F3AFE85780A387C--