Improve error message for 'playground.py docu' if doxygen is not available

Bug #321487 reported by Daniel Bültmann
2
Affects Status Importance Assigned to Milestone
openWNS SDK
Fix Committed
Medium
Daniel Bültmann

Bug Description

Currently the following output is generated if the documentation is built and doxygen cannot be found. The docu command should check its prerequisites before starting and give proper error messages to the user.

./playground.py --noAsk docu
 in dir /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build (timeout 1200 secs)
 watching logfiles {}
 argv: ['./playground.py', '--noAsk', 'docu']
 environment:
  HOME=/var/lib/buildbot
  LOGNAME=buildbot
  MAIL=/var/mail/buildbot
  PATH=/usr/local/bin:/usr/bin:/bin:/usr/games
  PWD=/var/lib/buildbot
  PYTHONPATH=:/var/lib/buildbot/.wns
  SHELL=/bin/sh
  TERM=linux
  USER=buildbot
Identifying projects for documentation ...
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/documentation
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/library
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/application
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/rise
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/dllbase
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/loadgen/constanze
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/mock/simpletl
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/phy/ofdmaphy
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/dll/wifimac
... found: /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/nl/ip
Preparing examples.
Removing old examples.
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/documentation
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/documentation
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/library
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/library
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/application
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/application
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/rise
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/rise
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/dllbase
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/framework/dllbase
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/loadgen/constanze
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/loadgen/constanze
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/mock/simpletl
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/mock/simpletl
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/phy/ofdmaphy
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/phy/ofdmaphy
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/dll/wifimac
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/dll/wifimac
Generating C++ examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/nl/ip
Generating Python examples for /var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/modules/nl/ip
Calling doxygen ... please wait: 'doxygen -'
Traceback (most recent call last):
  File "./playground.py", line 106, in <module>
    core.run()
  File "/var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/sandbox/default/lib/python2.4/site-packages/wnsbase/playground/Core.py", line 177, in run
    self.command.run()
  File "/var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/sandbox/default/lib/python2.4/site-packages/wnsbase/playground/builtins/Documentation/Documentation.py", line 61, in run
    self.cppDocuCommand.run()
  File "/var/lib/buildbot/slaves/buildbot.openwns.org/ubuntu8-04/docu/build/sandbox/default/lib/python2.4/site-packages/wnsbase/playground/builtins/CPPDocumentation/CPPDocumentation.py", line 146, in run
    stdIn.write(conf)
IOError: [Errno 32] Broken pipe
program finished with exit code 1

Related branches

Revision history for this message
Daniel Bültmann (daniel.bueltmann) wrote :

This is also true for the make, pdflatex and dot command. When fixing this the original commands cppdocu, pycodocu and createmanuals should also check their prerequisites.

Changed in openwns-sdk:
assignee: nobody → daniel.bueltmann
importance: Undecided → Medium
status: New → In Progress
Changed in openwns-sdk:
status: In Progress → Fix Committed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.