This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[Ada] Fix typo in style guide
- From: Florian Weimer <fw at deneb dot enyo dot de>
- To: gcc-patches at gcc dot gnu dot org
- Cc: bosch at gnat dot com, dewar at gnat dot com, charlet at act-europe dot fr
- Date: Tue, 18 Jan 2011 20:12:36 +0100
- Subject: [Ada] Fix typo in style guide
This almost qualifies as obvious. The style rule is currently
self-contradictory, so it could mean either thing, but I've checked a
few package specs, and the patch below seems to reflect the intended
meaning.
Okay for mainline?
2011-01-18 Florian Weimer <fw@deneb.enyo.de>
* gnat-style.texi (Lexical Elements): Fix typo.
Index: gnat-style.texi
===================================================================
--- gnat-style.texi (revision 168958)
+++ gnat-style.texi (working copy)
@@ -299,7 +299,7 @@
Descriptions of what subprograms do go with the specification.
@item
-Comments describing a subprogram spec should specifically mention the
+Comments describing a subprogram spec should not specifically mention the
formal argument names. General rule: write a comment that does not
depend on the names of things. The names are supplementary, not
sufficient, as comments.