aboutsummaryrefslogtreecommitdiff
path: root/GUIDELINES
blob: 4c7e6f72b7594315d4690087cefdd0df11ddca66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
Firma Development Policy
------------------------

Abstract: this policy helps control all development
          steps to keep a clean and junk-free code.

In the future this procedure will be automatic.

1 - After any addition to firma, check the following:
----------------------------------------------------

  - If a new variable has to be declared via a config-file,
    remember to set it to be created in the NewList function.

  - Put all new functions in the FUNCTIONS variable.

  - Put all new global variables in the GLOBAL_VARS variable.

  - If you are using an unix command, check if its already
    listed in the commands list. If it's not, please add it
    at the bottom of this file.

2 - Variables usage
-------------------

  - Global vars: uppercase, with spaces replaced by underscores.

  - Local vars: lowercase, with spaces replaced by underscores and
                declared using "local".

  - Attention to variables initialization, unset all vars after use.

3 - Used unix commands
----------------------

   bash itself

   $GPG_BINARY
   $MAIL_AGENT

   basename
   chmod
   chown
   cut
   echo
   expect
   fold
   grep
   head
   logger
   mkdir
   mv
   rm
   sed
   sha1sum
   sleep
   sort
   touch
   tr
   uniq
   wc