make doc returns a non-zero value

[Nick Veitch]

In the jenkins task set up for testing, the 'make doc' section returns a non-zero value. This prevents the online documentation from being generated properly.

http://10.189.74.2:8080/view/Maas/job/maas-merger-trunk/174/console

Note the following lines:

<autodoc>:: ERROR: Unknown target name: "user".
make[1]: Leaving directory `/home/ubuntu/launchpad-jobs/workspace/maas-merger-trunk/trunk/docs/_build'

I think this is what's causing the make doc generation to fail (although the docs are correctly generated, make still thinks a failure happened which makes the subsequent commands cp and rsync to fail)

[Gavin Panella (allenap)]

Can you link to a report in Jenkins? The last time I looked at this it
was okay, and I wasn't able to reproduce anything locally in 1.2 or
trunk. I wonder if there's actually something else going wrong, but
the logs from the doc generation are obscuring it.

[Gavin Panella (allenap)]

Thanks for the update, it's useful. What build steps or script is running here?

[Diogo Matsubara (matsubara)]

The following is run after the maas-merger-trunk jenkins job runs the test suite successfully:

#!/bin/bash
cd trunk
make doc && cp -a docs/_build/ $JENKINS_HOME/maas-docs/trunk && ssh -i $JENKINS_HOME/.ssh/maas-doc-publish <email address hidden> /home/maas-doc-publish/bin/maas-doc-publish-trigger trunk

So, make doc is returning a non-zero value causing the && cp... to fail afterwards.

[Diogo Matsubara (matsubara)]

Btw, this is what I get locally (i.e. my laptop): https://pastebin.canonical.com/82497/

As you can see, I don't get the errors shown in jenkins, only warnings but make docs still returns a non-zero value:

make[1]: quittant le répertoire « /home/matsubara/devel/canonical/maas/maas-branches/trunk/docs/_build »

[Nick Veitch (evilnick)]

On 18/01/13 17:44, Diogo Matsubara wrote:
> Btw, this is what I get locally (i.e. my laptop):
> https://pastebin.canonical.com/82497/
>
> As you can see, I don't get the errors shown in jenkins, only warnings
> but make docs still returns a non-zero value:
>
> make[1]: quittant le répertoire « /home/matsubara/devel/canonical/maas
> /maas-branches/trunk/docs/_build »
>
If the warnings cause the [1], then we have a problem. It isn't easy to
remove those warnings - those docs aren't in the toctree because they
aren't part of the main documentation.

--
Nick Veitch,
Technical Writer, Cloud Engineering, Canonical
https://launchpad.net/~evilnick

[Diogo Matsubara (matsubara)]

Let's hope this is not because of the warnings. Not sure if it's relevant but make's man page says:

EXIT STATUS
       GNU make exits with a status of zero if all makefiles were successfully
       parsed and no targets that were built failed. A status of one will be
       returned if the -q flag was used and make determines that a target
       needs to be rebuilt. A status of two will be returned if any errors
       were encountered.

I looked at MAAS' Makefile but didn't find any -q flag, so don't know if it's relevant here. Gavin likely knows.

[Nick Veitch (evilnick)]

\o/

On Wed, Sep 18, 2013 at 10:34 AM, Raphaël Badin
<email address hidden>wrote:

> ** Changed in: maas
> Status: Triaged => Fix Committed
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1100777
>
> Title:
> make doc returns a non-zero value
>
> Status in MAAS:
> Fix Committed
>
> Bug description:
> In the jenkins task set up for testing, the 'make doc' section returns
> a non-zero value. This prevents the online documentation from being
> generated properly.
>
> http://10.189.74.2:8080/view/Maas/job/maas-merger-trunk/174/console
>
> Note the following lines:
>
> <autodoc>:: ERROR: Unknown target name: "user".
> make[1]: Leaving directory
> `/home/ubuntu/launchpad-jobs/workspace/maas-merger-trunk/trunk/docs/_build'
>
> I think this is what's causing the make doc generation to fail
> (although the docs are correctly generated, make still thinks a
> failure happened which makes the subsequent commands cp and rsync to
> fail)
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/maas/+bug/1100777/+subscriptions
>