Mercurial > gnulib
changeset 40234:fab7ce42e03f
gnulib-tool: Clarify the coding style.
Suggested by Pavel Raiskup <praiskup@redhat.com>.
* gnulib-tool: Add comment about coding style.
author | Bruno Haible <bruno@clisp.org> |
---|---|
date | Wed, 13 Mar 2019 20:00:53 +0100 |
parents | 331ec5f027a2 |
children | 5a52ef2d4772 |
files | ChangeLog gnulib-tool |
diffstat | 2 files changed, 29 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Wed Mar 13 11:14:26 2019 -0700 +++ b/ChangeLog Wed Mar 13 20:00:53 2019 +0100 @@ -1,3 +1,9 @@ +2019-03-13 Bruno Haible <bruno@clisp.org> + + gnulib-tool: Clarify the coding style. + Suggested by Pavel Raiskup <praiskup@redhat.com>. + * gnulib-tool: Add comment about coding style. + 2019-03-11 Paul Eggert <eggert@cs.ucla.edu> strtod: fix clash with strtold
--- a/gnulib-tool Wed Mar 13 11:14:26 2019 -0700 +++ b/gnulib-tool Wed Mar 13 20:00:53 2019 +0100 @@ -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='