fix: docs error blocking API-doc generation under Windows... #6990
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
...in the case where TMPDIR environment variable pointed to a drive
different than the LVGL project directory. (TMPDIR is used by Python
`tempfile.mkdtemp()` used in `build.py`.) The result was on Windows
Doxygen was running in the LVGL project's `./docs/` directory instead
of the temporary directory where it was intended to run, causing
Doxygen to generate XML files for the API pages in in the wrong place.
The solution was to replace the attempted `cd` with a cross-platform
compatible `cd` built into Python's `os` library by temporarily having
the `build.py` script change directories to where Doxygen should run
and change back again after running it.
Additionally:
1. Handled 2 Python warnings where a regex string was using an illegal
escape sequence by making it a "raw" string, since the escape
backslash needs to be passed un-interpreted to the regex.
2. Replaced `build.py`s get_version() function with one that works
on both Linux and Windows platforms. Credit: @kdschlosser.
Resolves lvgl#6924.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
...in the case where TMPDIR environment variable pointed to a drive different than the LVGL project directory. (TMPDIR is used by Python
tempfile.mkdtemp()used inbuild.py.) The result was on Windows Doxygen was running in the LVGL project's./docs/directory instead of the temporary directory where it was intended to run, causing Doxygen to generate XML files for the API pages in in the wrong place. The solution was to replace the attemptedcdwith a cross-platform compatiblecdbuilt into Python'soslibrary by temporarily having thebuild.pyscript change directories to where Doxygen should run and change back again after running it.Additionally:
Handled 2 Python warnings where a regex string was using an illegal escape sequence by making it a "raw" string, since the escape backslash needs to be passed un-interpreted to the regex.
Replaced
build.pys get_version() function with one that works on both Linux and Windows platforms. Credit: @kdschlosser.Resolves #6924.
Notes
lv_conf_template.hrun lv_conf_internal_gen.py and update Kconfig. n/ascripts/code-format.py(astyle v3.4.12needs to installed by runningcd scripts; ./install_astyle.sh) and follow the Code Conventions. n/a