Misc documentation and build fixes - #249
Merged
Merged
Conversation
Borrowed from libasdf-gwcs where I added this while working on its docs.
In the libasdf-gwcs docs I also copied libasdf's development.rst and made some improvements to it--those improvements, such that are applicable also in libasdf, I tried to sync back up here.
I had forgotten the third argument to AC_ARG_ENABLE/WITH is *not* the "enabled" case, it's whether an --enable-foo or --disable-foo was given at all as opposed to absent (the 4th argument). This often trips me up.
The destructor that cleaned up the test directory at the end of a test executable was *too* destructive and could lead to race conditions where the test directory gets deleted between test programs like: A: get_run_dir() (creates run dir) B: get_run_dir() (reuses existing run dir) A: finishes (deletes run dir) B: tries to write file to run_dir (gets ENOENT) Better to just not delete them, even if they happen to be empty. The `latest` symlink will still point to the most recent. This makes a few additional attempts as well to more carefully avoid race conditions (e.g. a partially written or empty coordination file). It also adds a `run-dir` helper program that can be used in the shell tests so that they also write cleanly into per-test-run directories.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
A few minor fixes to apply before 0.1.0 final. Some things that resulted from working on the libasdf-gwcs documentation, and some nitpicks I found while experimenting with the homebrew formula.
AI Disclosure
No AI tools used.