From 9b468c5654d0029af7680179496c24ec83a9fad6 Mon Sep 17 00:00:00 2001 From: Christian Dywan Date: Sat, 6 Feb 2010 17:31:03 +0100 Subject: [PATCH] Add notes about variable ordering and prefixes to HACKING file --- HACKING | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/HACKING b/HACKING index 482ca097..944dfa8a 100644 --- a/HACKING +++ b/HACKING @@ -8,13 +8,16 @@ avoid automated line-breaks. Trailing whitespace is not desirable. Declarations go to the beginning of a block, not inline. Variables of one plain type may be grouped in one declaration, pointer types may not be grouped. The asterisk goes next to the type. +Variables should be ordered in the order they are used. Comments explain functionality, they should not state facts. The appropriate style is always C style /* */, not C++ style. Variable and function names should be animal, animal_shelter or animalsc in case it would otherwise be very long. Loop counters may be single letters. -Type names should be Animal, AnimalShelter or AnimalSC. +Type names should be Animal, AnimalShelter or AnimalSC. No prefixes from third +party projects should be used, such as GTK or WebKit, while underlines may be +used but do not have a particular meaning. There is a space between functions or keywords and round brackets, and curly brackets always go on separate lines, at the indentation level of the -- 2.39.5