This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: [DOC PATCH] Rewrite docs for inline asm
- From: Chung-Ju Wu <jasonwucj at gmail dot com>
- To: dw <limegreensocks at yahoo dot com>
- Cc: gcc patches <gcc-patches at gcc dot gnu dot org>, Gerald Pfeifer <gerald at pfeifer dot com>, Joseph Myers <joseph at codesourcery dot com>, Hans-Peter Nilsson <hp at bitrange dot com>, Andrew Haley <aph at redhat dot com>, Richard Sandiford <rdsandiford at googlemail dot com>
- Date: Wed, 23 Apr 2014 11:35:26 +0800
- Subject: Re: [DOC PATCH] Rewrite docs for inline asm
- Authentication-results: sourceware.org; auth=none
- References: <533F0C97 dot 2010206 at yahoo dot com> <alpine dot BSF dot 2 dot 02 dot 1404081759100 dot 23831 at arjuna dot pair dot com> <5344DAC3 dot 90005 at yahoo dot com> <alpine dot BSF dot 2 dot 02 dot 1404122053010 dot 48644 at arjuna dot pair dot com> <534A5BFD dot 3000906 at yahoo dot com> <alpine dot BSF dot 2 dot 02 dot 1404132037070 dot 39694 at arjuna dot pair dot com> <534B7F38 dot 9010605 at yahoo dot com>
2014-04-14 14:24 GMT+08:00 dw <limegreensocks@yahoo.com>:
> Having resolved the objections, I'm posting the updated patch. I don't have
> permissions to commit this patch, but I do have a release on file with the
> FSF.
>
>
> Problem description:
> The existing documentation does an inadequate job of describing gcc's
> implementation of the "asm" keyword. This has led to a great deal of
> confusion as people struggle to understand how it works. This entire section
> requires a rewrite that provides a structured layout and detailed
> descriptions of each of the parameters along with examples.
>
> ChangeLog:
> 2014-04-03 David Wohlferd (LimeGreenSocks@yahoo.com)
> Andrew Haley (aph@redhat.com)
> Richard Sandiford (rdsandiford@googlemail.com)
>
> * extend.texi: Completely rewrite inline asm section / reorg asm-related
> sections
>
> David Wohlferd
Hi, David,
A few nit picking about ChangeLog format:
1. The "extend.texi" is supposed to have "doc/" prefix.
2. 80-columns limit each line in the description.
3. Better have '.' at the end of a sentence.
So, the refine description is suggested using:
* doc/extend.texi: Completely rewrite inline asm section and reorg
asm-related sections.
Hope your patch can be approved soon. :)
Best regards,
jasonwucj