Andrew Kesterson
d55778e625
Four gaps in the maintenance guide, each one something a maintainer will hit. The two enforced checks were never named in it. api_surface (scripts/check_api_surface.sh) and error_protocol (scripts/check_error_protocol.py) fail builds and appear in ctest output, so the guide now says what each one asserts and why -- including that the API check strips comments before looking, because four of the nineteen symbols it found were mentioned in header prose and that is not the same as being declared. A new "Copying Into Fixed-Width Fields" section: never strncpy or memcpy into one of this library's fixed-width fields, use aksl_strncpy, bound n at sizeof(dest) - 1 to keep the truncate-not-reject contract, and know the one place the NUL padding is load-bearing. Ten sites had the unterminated form and one had the overreading memcpy form, and every name in this library is a registry key. The testing section gains the error-context ownership trap. TEST_EXPECT_* release whatever the statement returns, and some functions return the context they were given -- so a CLEANUP that also releases it double-releases, and a double-released context corrupts the failure rather than reporting it. A test written that way passes against broken code. That is not hypothetical; it is what the first AKERR_OUTOFBOUNDS test did. Also recorded: what ctest actually runs beyond the C suites, the gcovr positional search path and why it must stay, and the surviving GCOV returncode 5 trap. Plus rebuild.log to .gitignore -- it had been sitting in git status long enough to stop being noticed, which is the state a genuinely unexpected file needs to stand out from. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
17 lines
754 B
Plaintext
17 lines
754 B
Plaintext
# A leading ./ is not a valid gitignore pattern, so "./build/*" matched nothing
|
|
# and every out-of-tree build tree showed up as untracked. This also covers the
|
|
# instrumented trees scripts/coverage.py and the AKGL_COVERAGE option create.
|
|
build*/
|
|
.aider*
|
|
*~
|
|
|
|
# rebuild.sh captures its cmake output here. A build artifact, not a record --
|
|
# it sat untracked in `git status` long enough to become invisible, which is the
|
|
# state a genuinely unexpected untracked file needs to stand out from.
|
|
rebuild.log
|
|
|
|
# Generated by configure_file into the build tree. include/ precedes the build
|
|
# tree on the include path, so a stray copy here would silently shadow the real
|
|
# one and pin every consumer to whatever version it was generated at.
|
|
include/akgl/version.h
|