scripts: misc fixes, and clarify public vs. private with underscores #494
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 POSIX sh, there's no such thing as "public" or "private" functions. However, functions are allowed to contain underscores [1], so we're adopting the convention of leading underscores indicating a function which is not intended to be called by code in a different file. https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_235 |
This comment was marked as outdated.
This comment was marked as outdated.
gperciva
force-pushed
the
scripts-public-private
branch
from
25e93ca to
743422b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
gperciva
force-pushed
the
scripts-public-private
branch
from
743422b to
5a78d7e
Compare
gperciva
changed the title
- Add find_system() to the "public API", which should have been part of:
2023-06-29 scripts: misc fixes
ed4c19a
find_system() is not used by any other scripts in libcperciva, but
other projects make use of it.
- Fix the API comment for run_scenarios(), which should have been part of:
2021-03-24 tests: add `make test N=` to shared framework
acea39b
- Fix the API comment for valgrind_check_optional(), which was incorrect
from the very beginning:
2017-10-28 tests: import shared_test_functions.sh
d486415
- Use {} for $USE_VALGRIND and $PATH in comments. This should have been
part of:
2023-08-06 scripts: always use double quotes and curly braces
a1e8ac7
- document the public variables - define them in a single place - instead of recording the number of open file descriptors (as a public variable), just keep the relevant filename; we can extract the actual number every time we need it. This simplifies the logic of USE_VALGRIND_NO_REGEN.
In POSIX sh, there's no such thing as "public" or "private" functions. However, functions are allowed to contain underscores [1], so we're adopting the convention of leading underscores indicating a function which is not intended to be called by code in a different file. [1] https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_235 Private functions in shared_test_functions.sh: prepare_directory notify_success_or_fail scenario_runner Private functions in shared_valgrind_functions.sh: valgrind_prepare_directory valgrind_check_optional valgrind_process_suppression_file valgrind_ensure_suppression valgrind_get_basename valgrind_check_logfile
gperciva
force-pushed
the
scripts-public-private
branch
from
5a78d7e to
5b8921e
Compare
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.
No description provided.