749

15. Style du code

750

Ce chapitre documente le style du code utilisé dans les systèmes live.

751

15.1 Compatibilité

752

• N'utilisez pas une syntaxe ou sémantique qui soit unique au shell Bash. Par exemple, l'utilisation de tableaux (arrays).

753

• N'utilisez que le sous-ensemble POSIX − par exemple, utilisez $(foo) au lieu de `foo`.

754

• Vous pouvez vérifier vos scripts avec 'sh -n' et 'checkbashisms'.

755

• Assurez-vous que tout le code fonctionne avec 'set-e '.

756

15.2 Indentation

757

• Utilisez toujours des tabulations au lieu des espaces.

758

15.3 Adaptateur

759

• Généralement, les lignes sont de 80 caractères au maximum.

760

• Utilisez le «style Linux» des sauts de ligne:

761

Mal:

762

if foo; then
         bar
fi

763

Bien:

764

if foo
then
         bar
fi

765

• La même chose vaut pour les fonctions:

766

Mal:

767

Foo () {
         bar
}

768

Bien:

769

Foo ()
{
         bar
}

770

15.4 Variables

771

• Les variables sont toujours en lettres majuscules.

772

• Les variables utilisées dans live-build commencent toujours par le préfixe LB_.

773

• Les variables temporaires internes dans live-build devraient commencer avec le préfixe _LB_.

774

• Les variables locales commencent avec le préfixe __LB_.

775

• Les variables en relation avec un paramètre de démarrage dans live-config commencent par LIVE_.

776

• Toutes les autres variables dans live-config commencent par le préfixe _.

777

• Utilisez des accolades autour des variables; écrivez par exemple ${FOO} au lieu de $FOO.

778

• Protégez toujours les variables avec des guillemets pour respecter les espaces potentiels: écrire "${FOO}" en lieu de ${FOO}.

779

• Pour des raisons de cohérence, utilisez toujours les guillemets lors de l'attribution des valeurs aux variables:

780

Mal:

781

FOO=bar

782

Bien:

783

FOO="bar"

784

• Si plusieurs variables sont utilisées, utilisez les guillemets pour l'expression complète:

785

Mal:

786

if [ -f "${FOO}"/foo/"${BAR}"/bar ]
then
         foobar
fi

787

Bien:

788

if [ -f "${FOO}/foo/${BAR}/bar" ]
then
         foobar
fi

789

15.5 Autres

790

• Utilisez "|" (sans les guillemets autour) comme séparateur dans les appels à sed, par exemple "sed -e 's|foo|bar|'" (sans" ").

791

• 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; ...".

792

• Utilisez case dans la mesure du possible au lieu de test, parce qu'il est plus facile à lire et plus rapide à exécuter.

793

• Utilisez des noms en majuscule pour les fonctions pour éviter toute interférence avec l'environnement des utilisateurs.