aboutsummaryrefslogtreecommitdiffstats
path: root/STYLE
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2016-07-24 21:29:06 +0200
committerTristan Gingold <tgingold@free.fr>2016-07-30 07:03:40 +0200
commit209711413b989f05c039b6d5bd6acfb888b54b5a (patch)
tree4b5713144ec0d893bbc0fa39045b8f81d87e12d8 /STYLE
parent91598880d64ed2be9a53c0b6a07c4fdf602e71c1 (diff)
downloadghdl-209711413b989f05c039b6d5bd6acfb888b54b5a.tar.gz
ghdl-209711413b989f05c039b6d5bd6acfb888b54b5a.tar.bz2
ghdl-209711413b989f05c039b6d5bd6acfb888b54b5a.zip
Update STYLE file.
Diffstat (limited to 'STYLE')
-rw-r--r--STYLE8
1 files changed, 7 insertions, 1 deletions
diff --git a/STYLE b/STYLE
index 3573e7b20..448e0ef6b 100644
--- a/STYLE
+++ b/STYLE
@@ -7,11 +7,17 @@ Allowed Ada93 features: the standard library, child packages.
Use assertions.
We try to follow the 'GNU Coding Standards' when possible: comments before
-declarations, two spaces end of sentences...
+declarations, two spaces at end of sentences, finish sentences with a dot.
But: 3 spaces for indentation.
No trailing spaces, not TAB (HT).
+Subprograms must have a comment before to describe it, like:
+ -- Analyze the concurrent statements of PARENT.
+ procedure Sem_Concurrent_Statement_Chain (Parent : Iir);
+The line before the comment must be a blank line (unless this is the first
+declaration). Don't repeat the comment before the subprogram body.
+
* For subprograms:
1) Declare on one line when possible:
function Translate_Static_Aggregate (Aggr : Iir) return O_Cnode