blob: 9f42294e8674a5b9af441eb73d6dd1aae0284ce4 (
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
:B~ Style de code
1~coding-style Style du code
Ce chapitre documente le style du code utilisé dans les systèmes live.
2~ Compatibilité
_* N'utilisez pas une syntaxe ou sémantique qui soit unique au shell
Bash. Par exemple, l'utilisation de tableaux (arrays).
_* N'utilisez que le sous-ensemble POSIX − par exemple, utilisez $(foo) au
lieu de `foo`.
_* Vous pouvez vérifier vos scripts avec 'sh -n' et 'checkbashisms'.
_* Assurez-vous que tout le code fonctionne avec 'set-e '.
2~ Indentation
_* Utilisez toujours des tabulations au lieu des espaces.
2~ Adaptateur
_* Généralement, les lignes sont de 80 caractères au maximum.
_* Utilisez le «style Linux» des sauts de ligne:
Mal:
code{
if foo; then
bar
fi
}code
Bien:
code{
if foo
then
bar
fi
}code
_* La même chose vaut pour les fonctions:
Mal:
code{
Foo () {
bar
}
}code
Bien:
code{
Foo ()
{
bar
}
}code
2~ Variables
_* Les variables sont toujours en lettres majuscules.
_* Les variables utilisées dans live-build commencent toujours par le
préfixe #{LB_}#.
_* Les variables temporaires internes dans live-build devraient commencer
avec le préfixe #{\_LB_}#.
_* Les variables locales commencent avec le préfixe #{\_\_LB_}#.
_* Les variables en relation avec un paramètre de démarrage dans live-config
commencent par #{LIVE_}#.
_* Toutes les autres variables dans live-config commencent par le préfixe
#{_}#.
_* Utilisez des accolades autour des variables; écrivez par exemple
#{${FOO}}# au lieu de #{$FOO}#.
_* Protégez toujours les variables avec des guillemets pour respecter les
espaces potentiels: écrire #{"${FOO}"}# en lieu de #{${FOO}}#.
_* Pour des raisons de cohérence, utilisez toujours les guillemets lors de
l'attribution des valeurs aux variables:
Mal:
code{
FOO=bar
}code
Bien:
code{
FOO="bar"
}code
_* Si plusieurs variables sont utilisées, utilisez les guillemets pour
l'expression complète:
Mal:
code{
if [ -f "${FOO}"/foo/"${BAR}"/bar ]
then
foobar
fi
}code
Bien:
code{
if [ -f "${FOO}/foo/${BAR}/bar" ]
then
foobar
fi
}code
2~ Autres
_* Utilisez "#{|}#" (sans les guillemets autour) comme séparateur dans les
appels à sed, par exemple "#{sed -e 's|foo|bar|'}#" (sans" ").
_* N'utilisez pas la commande #{test}# pour des comparaisons ou des tests,
utilisez "#{[}#" "#{]}#" (sans ""); par exemple "#{if [ -x /bin/foo ];
...}#" et non pas "#{if test -x /bin/foo; ...}#".
_* Utilisez #{case}# dans la mesure du possible au lieu de #{test}#, parce
qu'il est plus facile à lire et plus rapide à exécuter.
_* Utilisez des noms en majuscule pour les fonctions pour éviter toute
interférence avec l'environnement des utilisateurs.
|
