diff options
Diffstat (limited to 'HACKING')
| -rw-r--r-- | HACKING | 25 |
1 files changed, 10 insertions, 15 deletions
@@ -50,16 +50,17 @@ ============================================================================ = Naming -* We've adopted the convention that internal AC_SUBSTs and make variables - should be named with a leading 'am__', and internally generated targets - should be named with a leading 'am--'. This convention, although in - place from at least February 2001, isn't yet universally used. - But all new code should use it. +* Internal make variables and functions should be named following patterns + like 'am.tty-colors' or 'am.dist.files'. - We used to use '_am_' as the prefix for an internal AC_SUBSTs. - However, it turns out that NEWS-OS 4.2R complains if a Makefile - variable begins with the underscore character. Yay for them. - I changed the target naming convention just to be safe. +* Internal AC_SUBSTs should be named with a leading 'am__'. + +* Private make targets should be named with a leading 'am--'. + +* WARNING! This convention, introduced recently (since July 2012), + isn't yet universally used. But all new code should use it, + except in those situation where that would cause spurious + conflicts with mainline Automake. ============================================================================ = Editing '.am' files @@ -72,12 +73,6 @@ * Never use basename or dirname. Instead, use sed. -* Do not use 'cd' within back-quotes, use '$(am__cd)' instead. - Otherwise the directory name may be printed, depending on CDPATH. - More generally, do not ever use plain 'cd' together with a relative - directory that does not start with a dot, or you might end up in one - computed with CDPATH. - * For install and uninstall rules, if a loop is required, it should be silent. Then the body of the loop itself should print each "important" command it runs. The printed commands should be preceded by a single |