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

From: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Date: Apr 25, 2016, 09:37 UTC
Message-ID: <vpq8u02yqp5.fsf@anie.imag.fr>
In-Reply-To: <E752A0BF-92D9-4BCF-ADD2-94F8E7BD66F2@gmail.com>

Lars Schneider <larsxschneider@gmail.com> writes:

Show 5 quoted lines

> On 22 Apr 2016, at 11:07, Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> wrote:
>
>> The ; or the newline is not needed either.
> Unfortunately it seems to be required. Travis CI generates a shell script
> out of the yml file and I think they don't respect newlines or something...

OK.

Show 9 quoted lines

>>> +          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 ...?
> I am curious. Do you have an example on what platform echo "-something" 
> could go wrong? I wasn't aware of such an issue.

echo can, but doesn't have to implement non-POSIX options. For example,

  $ dash -c 'echo -e foo'
  -e foo
  $ bash -c 'echo -e foo'
  foo

This is a good reason to avoid

  echo "$string"

if $string is a user-supplied string.

I don't know if any shell have issue with --------, but I wouldn't be surprised if some implementation complained with "invalid option ---------".

But it is also likely that I'm the one being paranoid and your code is fine ;-).

>> test -s Documentation/git.html &&
>> test -s Documentation/git.1
> Great idea. Added to v2! The && is not necessary as Travis runs this script with "set -e".

Maybe I'm doing too much Python, but "explicit is better than implicit" ;-). I'd keep the && in case someone ever moves the code to a script that doesn't have -e, but I'm really nit-picking here ;-).

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