[PATCH] 69759 - document __builtin_alloca and __builtin_alloca_with_align

Martin Sebor msebor@gmail.com
Mon Feb 22 20:01:00 GMT 2016


On 02/22/2016 10:53 AM, Andreas Schwab wrote:
> Martin Sebor <msebor@gmail.com> writes:
>
>> +@code{__BIGGEST_ALIGNMENT__} macro.  @code{__builtin_alloca} returns
>
> Another uncapitalized sentence beginning.

According to what I've read, whether or not a sentence should start
with the name of a code symbol that begins with a lowercase letter
appears to be left as a matter of preference by GNU style and coding
guidelines.  It's not discussed in the GCC Coding Conventions but it
is mentioned in the GCC Coding Standard and in the Texinfo manual
(with one copying from the other).  They both say that either is
fine.  The 277 occurrences of lowercase symbols following a period
at the end of a sentence in the GCC manual suggest that it's
an accepted practice.  But since I've lost this argument before
I attach another update to my patch to change this to the style
you prefer. I also moved the space from before the star after it
to accommodate Jakub's preference.

Incidentally, in my reading of the style guides, I found a couple
more obscure rules that I managed to violate.  Apparently, comments
in code examples are supposed to be surrounded in @r{} so they are
rendered in a variable-width font (I wonder if the term "variable-
width" is supposed to be hyphenated).  Judging by the paltry 81
instances (82 with my latest patch) of this annotation in the
docs, compared to a whopping 486 without, virtually no one knows
or cares about this one.

Another rule I had missed is "run time" vs "run-time" vs "runtime."

I've preemptively fixed these as well but I'm sure there are other
subtleties that I have overlooked.  I look forward to having them
pointed out in the next round.

Martin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: gcc-69780.patch
Type: text/x-patch
Size: 22486 bytes
Desc: not available
URL: <http://gcc.gnu.org/pipermail/gcc-patches/attachments/20160222/2d74c0c1/attachment.bin>


More information about the Gcc-patches mailing list