Repository navigation
docs: bring the module README up to date - #22
Merged
Merged
Conversation
Nine PRs of API and behaviour changes left the user-facing document behind: - document write_ex, the push switch, set_root_dir and the sidecar switch; - add the format struct and its validation rules; - correct the cleanup wording (it runs on the writer thread once, and only matches the .pcm suffix); - add a sidecar section covering naming, completeness and atomic writes; - list the new sources and the CMake build; - state explicitly that HAL call sites do not need to change.
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
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.
九个 PR 之后，面向使用者的 README 已经落后：只写了 write/stop，没有 write_ex、运行时开关、根目录、sidecar，文件结构也缺了 sidecar.c / dump_writer.c / 契约脚本 / CMakeLists。
这次补齐：
本地 check_docs_build_contract.sh 与 check_verification_flow.sh 均通过。