diff options
| author | Josh Morman <mormjb@gmail.com> | 2020-06-12 07:40:35 -0400 |
|---|---|---|
| committer | Josh Morman <mormjb@gmail.com> | 2020-06-12 07:40:35 -0400 |
| commit | 39311758cb1e6a7424d3213b3eb2c65c8c4dcfe1 (patch) | |
| tree | 4cdbc51f6fab543e67d5afbaa2760a0e6020cc1c /docs | |
| parent | 30ba1533ce1dbc6838acd3f58af1cd2d58dc06ee (diff) | |
pybind: update doc to include compile time info
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/PYBIND11.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/PYBIND11.md b/docs/PYBIND11.md index 0a04383279..9c6261d9e6 100644 --- a/docs/PYBIND11.md +++ b/docs/PYBIND11.md @@ -102,4 +102,8 @@ If Doxygen is enabled in GNU Radio and/or the OOT, Docstrings are scraped from t the `python/bindings/docstrings` directory and are used as placeholders for the scraped strings Upon compilation, docstrings are scraped from the module and stored in a dictionary (using `update_pydoc.py scrape`) and then -the values are substituted in the template file (using `update_pydoc.py sub`)
\ No newline at end of file +the values are substituted in the template file (using `update_pydoc.py sub`) + +## Compile Time + +The binding files are broken up into separate compilation units per block compared with the previous implementation where an entire module or larger groups of blocks were compiled together. Because of this, it is possible depending on the build machine that compilation of GNU Radio will take longer using pybind11. The upside is that when a single block source code is modified, the python bindings for the entire module do not have to be re-compiled. This can significantly improve compile time when actively debugging or modifying a single block. |