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

Factor out some file-generation machinery #181

Merged
merged 9 commits into from
May 17, 2024

Commits on Mar 6, 2024

  1. introduced a shell-script to factor out some file-generation stuff fr…

    …om the main Makefiles.
    mabruzzo committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    0840b40 View commit details
    Browse the repository at this point in the history

Commits on Mar 25, 2024

  1. More refactoring of autogeneration. We now use standard template file…

    …s. Autogeneration should now be a lot more transparent.
    mabruzzo committed Mar 25, 2024
    Configuration menu
    Copy the full SHA
    dea6224 View commit details
    Browse the repository at this point in the history

Commits on Apr 9, 2024

  1. Configuration menu
    Copy the full SHA
    dc4b38d View commit details
    Browse the repository at this point in the history
  2. consolidating configure.py

    mabruzzo committed Apr 9, 2024
    Configuration menu
    Copy the full SHA
    07e1d76 View commit details
    Browse the repository at this point in the history

Commits on Apr 17, 2024

  1. Configuration menu
    Copy the full SHA
    11d49b9 View commit details
    Browse the repository at this point in the history

Commits on Apr 21, 2024

  1. Modified docs to load version from VERSION file

    This was achieved by tweaking `doc/source/conf.py`.
    
    This triggered a few cascading changes:
    1. I needed to rename `config/query-version.py` to `config/query_version.py` so that it's contents could be properly imported
    2. I needed to slightly tweak the internals of `config/query_version.py` so that the function returned values (instead of directly printing the value). To reflect this change in behavior, I changed a function name from `show_version` to `query_version`
    3. While doing this, I also fixed a bug in some functionality from `config/query_version.py` that was intended to strip off a trailing '\n' character from the result of a shell command. In some cases, a trailing line-break might not be present and the functionality accidentally striped off a different character instead.
    4. I needed to adjust a path in `src/clib/Makefile` to reflect the new name of the `config/query_version.py` script
    mabruzzo committed Apr 21, 2024
    Configuration menu
    Copy the full SHA
    1a5d6c3 View commit details
    Browse the repository at this point in the history

Commits on May 7, 2024

  1. Bugfix: move LIB_RELEASE_VERSION definition between Makefiles

    Previously, `LIB_RELEASE_VERSION` was defined in `src/clib/Make.config.assemble`.
    - This was fine, when `LIB_RELEASE_VERSION` was assigned a hardcoded value
    - however, after we started to use a script to retrieve this value, error messages were printed whenever we invoked the `src/example/Makefile` (to build code-examples)
    - The error messages arise because the path to the script was encoded within the `QUERY_VERSION` variable and that variable was not defined when `src/example/Makefile` included `src/clib/Make.config.assemble`
    - Since script-path is only defined within `src/clib/Makefile` I decided to move the definition of `LIB_RELEASE_VERSION` to that file.
    
    NOTE: since the `LIB_RELEASE_VERSION` wasn't actually used by `src/example/Makefile` the error-messages before this commit were entirely benign.
    mabruzzo committed May 7, 2024
    Configuration menu
    Copy the full SHA
    9f4fa15 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    b444023 View commit details
    Browse the repository at this point in the history
  3. Remove tail invocation from config/query_version.py

    The required logic to fetch the last line of the file is now implemented in python. The logic loops over all lines from the VERSION file (from beginning to end) and returns the final non-empty line. This is fine for the VERSION file which should really just be 1 line (but is suboptimal for large files)
    mabruzzo committed May 7, 2024
    Configuration menu
    Copy the full SHA
    061f3be View commit details
    Browse the repository at this point in the history