GNU autotools : Cibles Debug/Release ?

Question

Ça fait un moment que je cherche ça : Je suis en train de convertir un programme de taille moyenne en autotools, à partir d'une méthode basée sur Eclipse (avec des makefiles).

J'ai toujours eu l'habitude d'avoir une version "debug", avec tous les symboles de débogage et aucune optimisation, et une version "release", sans symboles de débogage et avec les meilleures optimisations.

J'essaie maintenant de reproduire cela d'une manière ou d'une autre avec autotools, afin de pouvoir (peut-être) faire quelque chose du genre :

./configure
make debug

Qui aurait tous les symboles de débogage et aucune optimisation, et où :

./configure
make

donnerait la version "release" (par défaut)

PS : J'ai lu à propos du drapeau/de la fonctionnalité --enable-debug, mais dans ma configuration actuelle (simple), l'utilisation de ce drapeau n'est pas reconnue par le programme configure

Answer 1

La solution d'ismail est une approche courante, mais elle souffre de quelques problèmes sérieux. Si l'utilisateur essaie d'obtenir une compilation de débogage en faisant './configure --enable-debug', le script de configure fixera les CFLAGS à '-g -O2' et le Makefile utilisera '-g3 -O0 .... -g -O2' lors de la construction de tout exécutable. Dans ce cas, gcc utilisera -O2, et certains compilateurs s'arrêteront à cause des options -O conflictuelles. Ces deux scénarios ne sont pas le comportement attendu.

Construire avec des symboles de débogage ou non n'est PAS quelque chose dont le responsable du projet doit se préoccuper. du tout . C'est un problème pour l'utilisateur. Si vous construisez un projet et que vous voulez faire un build de débogage ou un build de version, vous devez utiliser différentes options au moment de la configuration. Par exemple,

$ mkdir debug
$ mkdir release
$ cd debug && /path/to/configure --prefix=/dbg \
   CPPFLAGS=-DDEBUG CFLAGS="-g -O0" && make && make install
$ cd ../release && /path/to/configure CPPFLAGS=-DNDEBUG && make && make install

Cela installera une compilation avec `-DDEBUG' et '-g -O0' (une "compilation de débogage") dans /dbg/bin et une installation de "libération" dans /usr/local/bin.

Vous pouvez réduire l'ennui de la saisie nécessaire en utilisant un fichier CONFIG_SITE. Par exemple, vous pouvez le faire :

echo 'CPPFLAGS=-DDEBUG CFLAGS="-g -O0"' >> /dbg/share/config.site

et toutes les invocations futures de 'configure --prefix=/dbg' hériteront automatiquement des paramètres de CPPFLAGS et CFLAGS sans avoir à les spécifier sur la ligne de commande.

Si, en tant que responsable du paquet, vous souhaitez fournir à l'utilisateur un moyen facile de construire une "version de débogage", il est parfaitement acceptable d'inclure un script dans la distribution qui invoque le script de configuration avec les arguments appropriés et invoque make && make install mais il n'est absolument pas nécessaire d'encombrer vos métafichiers d'outils automatiques avec de tels déchets. Il n'a tout simplement pas sa place ici. Et soyez prévenus, de nombreux paquets ont tenté d'ajouter des métafichiers --enable-debug qui sont tout simplement faux. Si l'utilisateur invoque configure CFLAGS="-g -O0" mais obtient une construction qui applique des drapeaux inattendus, alors vous avez un bogue et votre paquet est brisé . C'est une expérience bien trop commune, et si vous maintenez un paquet (actuellement en train de penser à tmux y curl ) dans lequel l'utilisateur n'obtient pas ce qu'une personne raisonnable appellerait une "compilation de débogage" après avoir invoqué la commande configure CFLAGS="-g -O0" alors votre paquet est brisé .

Un point important dont il faut toujours se souvenir lors de la maintenance d'un paquet avec les autotools est que l'utilisateur peut utiliser une chaîne d'outils complètement différente de la vôtre. Il est tout à fait possible que la chaîne d'outils de l'utilisateur requière -DMAKE_IT_A_DEBUG o -DUSE_DEBUG o -I/non/standard/path/to/headers . Il faudra peut-être -O145 o -Q transmis au compilateur ou -debug transmis au linker, ou ... quoi que ce soit. En tant que mainteneur, vous ne disposez tout simplement pas des informations nécessaires pour que l'expression "debug build" ait un sens pour tous les utilisateurs. N'essayez donc pas, car vous pourriez rendre le logiciel impossible à construire pour un certain nombre d'utilisateurs.

Answer 2

Ajoutez une clause à votre configure.in o configure.ac fichier ;

AC_ARG_ENABLE(debug,
AS_HELP_STRING([--enable-debug],
               [enable debugging, default: no]),
[case "${enableval}" in
             yes) debug=true ;;
             no)  debug=false ;;
             *)   AC_MSG_ERROR([bad value ${enableval} for --enable-debug]) ;;
esac],
[debug=false])

AM_CONDITIONAL(DEBUG, test x"$debug" = x"true")

Maintenant, dans votre Makefile.in o Makefile.am ;

if DEBUG
AM_CFLAGS = -g3 -O0
AM_CXXFLAGS = -g3 -O0
else
AM_CFLAGS = -O2
AM_CXXFLAGS = -O2
endif

Alors quand debug est activé, vous pouvez modifier votre {C/CXX}FLAGS pour activer les informations de débogage.

Answer 3

Le Makefile par défaut créé avec autotools produit des binaires avec des symbôles de débogage. Utilisez make install-strip pour produire une cible de libération.

Answer 4

Un autre exemple pour configurer CFLAGS / CXXFLAGS sans montage Makefile.in o Makefile.am . Ajoutez ce code à votre configure.in o configure.ac fichier :

test -z "$SED" && SED=sed

AC_ARG_ENABLE([debug],
  [AS_HELP_STRING([--enable-debug],
                  [whether to include debug symbols (default is no)])],
  [enable_debug=$enableval],
  [enable_debug=no]
)

if test "x$enable_debug" = xyes; then
  dnl Remove all optimization flags from CFLAGS
  changequote({,})
  CFLAGS=`echo "$CFLAGS" | $SED -e 's/-O[0-9s]*//g'`
  CXXFLAGS=`echo "$CXXFLAGS" | $SED -e 's/-O[0-9s]*//g'`

  CFLAGS=`echo "$CFLAGS" | $SED -e 's/-g[0-9]*//g'`
  CXXFLAGS=`echo "$CXXFLAGS" | $SED -e 's/-g[0-9]*//g'`
  changequote([,])

  CFLAGS="$CFLAGS -g -O0"
  CXXFLAGS="$CXXFLAGS -g -O0"
fi

echo "CFLAGS=$CFLAGS"

Testez-le :

$ ./configure --enable-debug | grep CFLAGS