Re: [PATCH v1] travis-ci: build documentation

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Apr 22, 2016, 09:07 UTC
Message-ID: <vpq37qeovu4.fsf@anie.imag.fr>
In-Reply-To: <1461314042-3132-1-git-send-email-larsxschneider@gmail.com>

larsxschneider@gmail.com writes:

> +      if [[ "$TRAVIS_OS_NAME" = linux ]] && [[ "$CC" = gcc ]];

[[ is a bashism, and doesn't bring anything here compared to the POSIX [ ... ], or "test" which is prefered in Git's source code.

The ; or the newline is not needed either.

I'd write

if test "$TRAVIS_OS_NAME" = linux && test "$CC" = gcc; then

> +          then
> +          echo ""
> +          echo "------------------------------------------------------------------------" &&

I usualy avoid "echo <something-starting-with-dash>" as I'm not sure how portable it is across variants of "echo". Maybe this one is portable enough, I don't know. Perhaps printf, or cat << EOF ...?

> +          echo "$(tput setaf 2)Building documentation...$(tput sgr0)" &&
> +          make --quiet doc
> +      fi;

Nit: useless ;

I think it makes sense to do some lightweight checks after "make doc", rather than just check the return code. For example, check that a few generated files exist and are non-empty, like

test -s Documentation/git.html && test -s Documentation/git.1

Thanks,

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/