[RTEMS Project] #3311: Update waf.py for Sphinx 1.7 compatibility

RTEMS trac trac at rtems.org
Sun Mar 11 06:18:15 UTC 2018


#3311: Update waf.py for Sphinx 1.7 compatibility
------------------------------+--------------------------
 Reporter:  Richard Campbell  |       Owner:  Chris Johns
     Type:  defect            |      Status:  closed
 Priority:  normal            |   Milestone:
Component:  doc               |     Version:
 Severity:  normal            |  Resolution:  fixed
 Keywords:                    |  Blocked By:
 Blocking:                    |
------------------------------+--------------------------

Comment (by Chris Johns):

 I have reviewed the patch. It needs some more work.

 Please do not `import sphinx`. This is a build system and so you either
 need to know the module is present, ie `latex.py` which abstracts the
 latex handling or you add proper checks for a correctly install Python
 sphinx module, which in this case should not be needed cause the tool
 should have a command to print the version. Has that changed?

 Catching all exceptions like this to handle the case of a python module
 that is not installed is not a good idea, it may hides other issues that
 may appear. The previous code wrapped a single conversion line which is an
 accepted way to do this.

 What is wrong with asking Sphinx for it's version?

 Why require 2 calls to get the version?

--
Ticket URL: <http://devel.rtems.org/ticket/3311#comment:3>
RTEMS Project <http://www.rtems.org/>
RTEMS Project


More information about the bugs mailing list