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

Support --parallel auto option #17

Open
StephanKuempel opened this issue Apr 6, 2022 · 4 comments
Open

Support --parallel auto option #17

StephanKuempel opened this issue Apr 6, 2022 · 4 comments

Comments

@StephanKuempel
Copy link
Contributor

Currently, when specifiying sphinx-performance --parallel auto (equivalent sphinx-build -j auto) we get the error:
Error: Invalid value for '--parallel': 'auto' is not a valid integer.

@danwos
Copy link
Member

danwos commented Apr 6, 2022

Thanks for the reports, but I'm not sure if a performance-report script should provide a non reproducible option, which may interact differently on each machine.

Also "auto" would currently not get resolved in the report and you would have no glue, how many cpu cores got used for a specific report.

For me "auto" makes only sense, if you don't know the available cores on a system. But then I don't know, if a created report is comparable to any other report....

@StephanKuempel
Copy link
Contributor Author

Ok, makes sense, thne maybe just add to the doku, that with --parallel, the auto option is not supported like it is for -j in sphinx-build.
The -j option itself is not very good, since you never know if the number you specified is really supported/used, since sphinx limits itself internally if too big, so you'll never know for sure how many cores were used ;)

@danwos
Copy link
Member

danwos commented Apr 6, 2022

Thanks for the hint with -j.
Maybe in this case sphinx-performance should also do a check and write a warning, if not so many cores are available as specified.

@StephanKuempel
Copy link
Contributor Author

StephanKuempel commented Apr 6, 2022

Thanks for the hint with -j. Maybe in this case sphinx-performance should also do a check and write a warning, if not so many cores are available as specified.

Then sphinx-performance would be better than sphinx-build, actually ;)
As a side note: -j option doesn't work at all on Windows. Parallel is simply not supported, but sphinx-build doesn't give any info on that ...

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

No branches or pull requests

2 participants