extend.texi (attribute aligned): Expand.
authorMartin Sebor <msebor@redhat.com>
Tue, 4 Dec 2018 18:41:40 +0000 (18:41 +0000)
committerMartin Sebor <msebor@gcc.gnu.org>
Tue, 4 Dec 2018 18:41:40 +0000 (11:41 -0700)
gcc/ChangeLog:
* doc/extend.texi (attribute aligned): Expand.

From-SVN: r266792

gcc/ChangeLog
gcc/doc/extend.texi

index bbfe5ae30569deeae2e92c684a6aefe447dbd035..0ab1186cd40d353abe0075c5601e837daec963df 100644 (file)
@@ -1,3 +1,7 @@
+2018-12-04  Martin Sebor  <msebor@redhat.com>
+
+       * doc/extend.texi (attribute aligned): Expand.
+
 2018-12-04  David Edelsohn  <dje.gcc@gmail.com>
 
        PR target/61976
index e0f9b38f1b21021abab07c2df2de318e3a789677..0ae8bdde5ae77bff5d23b35b47419ad97fef73a5 100644 (file)
@@ -2442,16 +2442,20 @@ and may not be available on all targets.
 @itemx aligned (@var{alignment})
 @cindex @code{aligned} function attribute
 The @code{aligned} attribute specifies a minimum alignment for
-the function, measured in bytes.  When specified, @var{alignment} must
-be an integer constant power of 2.  Specifying no @var{alignment} argument
-implies the maximum alignment for the target, which is often, but by no
-means always, 8 or 16 bytes.
-
-You cannot use this attribute to decrease the alignment of a function,
-only to increase it.  However, when you explicitly specify a function
-alignment this overrides the effect of the
-@option{-falign-functions} (@pxref{Optimize Options}) option for this
-function.
+the first instruction of the function, measured in bytes.  When specified,
+@var{alignment} must be an integer constant power of 2.  Specifying no
+@var{alignment} argument implies the ideal alignment for the target.
+The @code{__alignof__} operator can be used to determine what that is
+(@pxref{Alignment}).  The attribute has no effect when a definition for
+the function is not provided in the same translation unit.
+
+The attribute cannot be used to decrease the alignment of a function
+previously declared with a more restrictive alignment; only to increase
+it.  Attempts to do otherwise are diagnosed.  Some targets specify
+a minimum default alignment for functions that is greater than 1.  On
+such targets, specifying a less restrictive alignment is silently ignored.
+Using the attribute overrides the effect of the @option{-falign-functions}
+(@pxref{Optimize Options}) option for this function.
 
 Note that the effectiveness of @code{aligned} attributes may be
 limited by inherent limitations in the system linker