chiark / gitweb /
documentation: expose search data packing options.
authorVladimír Vondruš <mosra@centrum.cz>
Sun, 9 Jan 2022 15:52:26 +0000 (16:52 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Sun, 9 Jan 2022 16:03:09 +0000 (17:03 +0100)
commit0411e1812f1274bf6e49404c0dcdf649f7637076
treef3efc5714b02a96a479d12405b8f8aa513c95c31
parentb0cf44e4ddbf42ce79a8612563e84e00e8a75808
documentation: expose search data packing options.

There are new SEARCH_RESULT_ID_BYTES, SEARCH_FILE_OFFSET_BYTES and
SEARCH_NAME_SIZE_BYTES options exposed in both Doxygen and Python doc
generator. Because they affect some internals that the regular user
shouldn't need to care about and don't reflect anything tangible like
project symbol count, they're not really documented.

On the other hand, they can't really be estimated beforehand The
estimator would either overestimate, leading to files larger than they
could be, or it underestimates, leading to random corner cases that
would be impossible to track down. Thus the project just starts with the
small sizes and if they're not enough, an exception with a (hopefully
helpful-enough) message is raised, suggesting users to adjust their
config.
doc/documentation/doxygen.rst
doc/documentation/python.rst
documentation/_search.py
documentation/doxygen.py
documentation/python.py
documentation/test/test_search.py
documentation/test_doxygen/test_doxyfile.py
documentation/test_doxygen/test_search.py
documentation/test_python/test_search.py