Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix problem where API doc gen misses some files #3292

Merged
merged 1 commit into from
Feb 6, 2019

Conversation

mwichmann
Copy link
Collaborator

@mwichmann mwichmann commented Feb 6, 2019

In doc/SConscript, the function in bootstrap.py to parse a manifest was called with an scons path (#src/engine) but bootstrap does not run in an scons context, it is run via subprocess.Popen. As a result, the glob matching failed to match files. The resulting list is passed to epydoc (at the moment) to generate the API docs, so the list should be correct (it was actually missing very little, since 14 of the missed files are later eliminated when the list is cleaned)

Preprocess the path before the call. Along the way, change the function to open the file itself instead of being passed a list already read from the file, update the comment, and clean some whitespace issues.

Did not updates src/CHANGES.txt since there was no change to scons source.

Signed-off-by: Mats Wichmann [email protected]

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated master/src/CHANGES.txt directory (and read the README.txt in that directory)
  • I have updated the appropriate documentation

In doc/SConscript, the function in bootstrap.py to parse a
manifest was called with an scons path (#src/engine) but bootstrap
does not run in an scons context, it is run via subprocess.Popen.
Preprocess the path. Along the way, change the function to open
the file itself instead of being passed a list already read
from the file, update the comment, and clean some whitespace issues.

Signed-off-by: Mats Wichmann <[email protected]>
@bdbaddog bdbaddog merged commit 0ac39b1 into SCons:master Feb 6, 2019
@mwichmann mwichmann deleted the bootstrap-doc branch February 6, 2019 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants