En este capítulo se documenta el estilo de código utilizado en los sistemas en vivo.
15.1 Compatibilidad
Avoid "bashisms", the codebase must be POSIX compliant and thus universally compatible.
Furthermore it must comply with the version of the POSIX specification chosen by the current Debian Policy.
Se puede comprobar las secuencias de comandos con 'sh -n' y 'checkbashisms'.
Asegurarse de que el código funcione con 'set -e'.
15.2 Sangrado
Utilizar siempre los tabuladores en lugar de espacios.
Keep case branch terminators (";;") aligned with the "content" of the branch, rather than the branch "entry".
Bien:
case "${1}" in
foo)
foobar
;;
bar)
foobar
;;
esac
15.3 Ajuste de líneas
Generally, lines should be 80 chars at maximum.
Placement of keywords like then and do should be chosen with good judgement with respect to clutter and readability. For small bits of code in particular it should be preferred to have them on the same line as the prior keyword they relate to (if; for; etc). Only place on the next line where it makes good sense to do so; typically this might only be to comply with maximum line length restrictions. One situation where they should always be placed on the next line is where what they follow is broken up onto multiple lines, and thus it being on a new line creates clear separation between that and the body of code following it. I.e. :
Preferred:
if foo; then
bar
fi
for FOO in $ITEMS; do
bar
done
if [ "${MY_LOCATION_VARIABLE}" = "something" ] && [ -e "${MY_OUTPUT_FILE}" ]
then
MY_OTHER_VARIABLE="$(some_bin ${FOOBAR} | awk -F_ '{ print $1 }')"
fi
if [ "${MY_FOO}" = "something" ] && [ -e "path/${FILE_1}" ] ||
[ "${MY_BAR}" = "something_else" ] && [ ${ALLOW} = "true" ]
then
foobar
fi
Less ideal:
if [ "${MY_LOCATION_VARIABLE}" = "something" ] && [ -e "${MY_OUTPUT_FILE}" ]; then
MY_OTHER_VARIABLE="$(some_bin ${FOOBAR} | awk -F_ '{ print $1 }')"
fi
Prefer placing the opening brace of a function on a new line (for consistency with established style), and keep the braces aligned with the function name:
Bien:
Foo ()
{
bar
}
Bad (inconsistent with existing style):
Foo () {
bar
}
Awful:
Foo ()
{
bar
}
15.4 Variables
Las variables deben escribirse siempre en letras mayúsculas.
Config variables used in live-build should start with an LB_ prefix.
Local function variables should be restricted to local scope.
Las variables en relación a un parámetro de arranque en live-config comienzan con LIVE_.
Todas las demás variables de live-config comienzan con el prefijo _
Utilizar llaves para las variables, por ejemplo, escribir ${FOO} en lugar de $FOO.
Always protect variables with quotes to respect potential whitespaces (except where necessary to achieve correct word splitting): write "${FOO}" not ${FOO}.
Por motivos de coherencia, se debe utilizar siempre comillas en la asignación de valores a las variables:
Mal:
FOO=bar
Bien:
FOO="bar"
If multiple variables are used, prefer quoting the full expression:
Typically bad:
if [ -f "${FOO}"/foo/"${BAR}"/bar ]; then
foobar
fi
Bien:
if [ -f "${FOO}/foo/${BAR}/bar" ]; then
foobar
fi
15.5 Miscelánea
Prefer "|" (without the surround quotes) as a separator in calls to sed, e.g. "sed -e 's|foo|bar|'" (without "").
Don't use the test command for comparisons or tests, use "[" and "]" (without ""); e.g. "if [ -x /bin/foo ]; ..." and not "if test -x /bin/foo; ...".
Use case wherever it makes code more readable than conditional checks (if foo; ... and tests without the actual if keyword, e.g. [ -e "${FILE}" ] || exit 0).
Use "Foo_bar" style names for functions, i.e. a capital first letter, then all lowercase, with sensible use of underscores for better readability.