From: Bruno Haible Date: Wed, 13 Mar 2019 19:00:53 +0000 (+0100) Subject: gnulib-tool: Clarify the coding style. X-Git-Tag: v1.0~5029 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=7952aabdf99f8083328f79eda136fe8718f7157a;p=gnulib.git gnulib-tool: Clarify the coding style. Suggested by Pavel Raiskup . * gnulib-tool: Add comment about coding style. --- diff --git a/ChangeLog b/ChangeLog index e5ba0caa4b..3a44133d9a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2019-03-13 Bruno Haible + + gnulib-tool: Clarify the coding style. + Suggested by Pavel Raiskup . + * gnulib-tool: Add comment about coding style. + 2019-03-11 Paul Eggert strtod: fix clash with strtold diff --git a/gnulib-tool b/gnulib-tool index 34d198f6d7..a41522ba0e 100755 --- a/gnulib-tool +++ b/gnulib-tool @@ -19,6 +19,29 @@ # This program is meant for authors or maintainers which want to import # modules from gnulib into their packages. +# CODING STYLE for this file: +# * Indentation: Indent by 2 spaces. Indent case clauses by 2 spaces as well. +# * Shell variable references: Use double-quote around shell variable +# references always (except when word splitting is explicitly desired), +# even when you know the double-quote are not needed. This style tends to +# avoid undesired word splitting caused by omitted double-quotes (the +# number one mistake in shell scripts). +# When the referenced variable can only have a finite number of possible +# values and these values are all simple words (e.g. true and false), it's +# OK to omit the double-quotes. +# * Backquotes: +# - Use backquotes like in `command`, not $(command). +# - Don't use `command` inside double-quotes. Instead assign the result of +# `command` to a variable, and use the value of the variable afterwards. +# * Functions: +# - All functions that don't emulate a program or shell built-in have a name +# that starts with 'func_'. +# - Document the implicit and explicit arguments of all functions, as well +# as their output variables and side effects. +# * Use test condition instead of [ condition ]. +# * Minimize the use of eval; when you need it, make sure the string to be +# evaluated has a very simple syntactic structure. + progname=$0 package=gnulib nl='