documentation: clarify that Cilk Plus implementation is incomplete
diff mbox

Message ID 52125414.8070906@redhat.com
State New
Headers show

Commit Message

Aldy Hernandez Aug. 19, 2013, 5:21 p.m. UTC
On 08/18/13 05:21, Gerald Pfeifer wrote:
> On Wed, 26 Jun 2013, Aldy Hernandez wrote:
>> This is a small cleanup to the Cilk Plus mention in our documentation,
>> but more importantly, it clarifies that the Cilk Plus implementation
>> in GCC is only partial.
>>
>> OK for trunk?
>
>      * doc/invoke.texi (-fcilkplus): Clarify that implementation is
>      incomplete.
>
> diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
> index dd82880..3150c8d 100644
> --- a/gcc/doc/invoke.texi
> +++ b/gcc/doc/invoke.texi
> @@ -1804,13 +1804,17 @@ have support for @option{-pthread}.
> @item -fcilkplus
> @opindex fcilkplus
> @cindex Enable Cilk Plus
> -Enable the usage of Cilk Language extension features for C/C++.  When
> the flag
> -@option{-fcilkplus} is specified, all the Cilk Plus components are
> converted -to the appropriate C/C++ code.  The present implementation
> follows ABI version -0.9.  There are four major parts to Cilk Plus
> language -extension: Array Notations, Cilk Keywords, SIMD annotations
> and elemental -functions.  Detailed information about Cilk Plus can be
> found at -@w{@uref{http://www.cilkplus.org}}. +When the option
> @option{-fcilkplus} is specified, enable the usage of
> +the Cilk Plus Language extension features for C/C++.  The present
> +implementation follows ABI version 0.9.  This is an experimental
> +feature that is only partially complete, and whose interface may
> +change in future versions of GCC, as the official specification
> +changes.  Currently only the array notation feature of the language
> +specification has been implemented.  More features will be implemented
> +in subsequent release cycles.
> +
> +Detailed information about Cilk Plus can be found at
> +@w{@uref{http://www.cilkplus.org}}.
>
> I would keep the first sentence as is, which is more in line how
> we generally describe options.

Done (fixed capitalization problems in original sentence though).

>
> No comma before "as the official".

Fixed.

>
> And personally I would omit the last sentence, but it's fine to
> keep if you really want to leave it.

Agreed.

I have committed the attached patch.

Thanks.
commit d73291f1eb8feee7a2f6b91af11e1e00de401a42
Author: Aldy Hernandez <aldyh@redhat.com>
Date:   Mon Aug 19 12:18:31 2013 -0500

    	* doc/invoke.texi (-fcilkplus): Clarify that implementation is
    	incomplete.

Patch
diff mbox

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 6645df9..dd6559d 100644
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,8 @@ 
+2013-08-19  Aldy Hernandez  <aldyh@redhat.com>
+
+	* doc/invoke.texi (-fcilkplus): Clarify that implementation is
+	incomplete.
+
 2013-08-19  Alexander Ivchenko  <alexander.ivchenko@intel.com>
 
 	* target.def (TARGET_LIBC_HAS_FUNCTION): New target hook.
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index f6a4ec4..dae7605 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -1811,13 +1811,15 @@  have support for @option{-pthread}.
 @item -fcilkplus
 @opindex fcilkplus
 @cindex Enable Cilk Plus
-Enable the usage of Cilk Language extension features for C/C++.  When the flag
-@option{-fcilkplus} is specified, all the Cilk Plus components are converted 
-to the appropriate C/C++ code.  The present implementation follows ABI version 
-0.9.  There are four major parts to Cilk Plus language 
-extension: Array Notations, Cilk Keywords, SIMD annotations and elemental 
-functions.  Detailed information about Cilk Plus can be found at 
-@w{@uref{http://www.cilkplus.org}}. 
+Enable the usage of Cilk Plus language extension features for C/C++.
+When the option @option{-fcilkplus} is specified, enable the usage of
+the Cilk Plus Language extension features for C/C++.  The present
+implementation follows ABI version 0.9.  This is an experimental
+feature that is only partially complete, and whose interface may
+change in future versions of GCC as the official specification
+changes.  Currently only the array notation feature of the language
+specification has been implemented.  More features will be implemented
+in subsequent release cycles.
 
 @item -fgnu-tm
 @opindex fgnu-tm