Rewrite of "RTIO concepts" manual page. Attempts to clarify fine vs. coarse timestamps (as also discussed in #1237), seamless handover and core resets, and the exact nature of the various RTIO exceptions/errors (the sections on collisions and busy errors are where I'm least certain of accuracy, review appreciated.)
Also deprecates #2277 by adopting only remaining relevant change (consolidating description of sequence errors).
Deliberately have not bothered to unify formatting (in the .rst itself, in the sense that much of this page is written with a line break after each sentence.) It's inconsistent across the manual in general and cleaning up those various formatting oddities can be a PR of its own someday.
Added: Clarification of behavior of DMA vs input methods/events
Related Issue
Type of Changes
Type
✓
:scroll: Docs
Steps (Choose relevant, delete irrelevant before submitting)
All Pull Requests
[x] Use correct spelling and grammar.
Documentation Changes
[x] Check, test, and update the documentation in doc/. Build documentation (cd doc/manual/; make html) to ensure no errors.
Git Logistics
[x] Split your contribution into logically separate changes (git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.
[x] Write short & meaningful commit messages. Review each commit for messages (git show). Format:
topic: description. < 50 characters total.
Longer description. < 70 characters per line
Licensing
See copyright & licensing for more info.
ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.
architeuthidae
commented
2 days ago
ARTIQ Pull Request
Description of Changes
Rewrite of "RTIO concepts" manual page. Attempts to clarify fine vs. coarse timestamps (as also discussed in #1237), seamless handover and core resets, and the exact nature of the various RTIO exceptions/errors (the sections on collisions and busy errors are where I'm least certain of accuracy, review appreciated.)
Also deprecates #2277 by adopting only remaining relevant change (consolidating description of sequence errors).
Deliberately have not bothered to unify formatting (in the .rst itself, in the sense that much of this page is written with a line break after each sentence.) It's inconsistent across the manual in general and cleaning up those various formatting oddities can be a PR of its own someday.
Added: Clarification of behavior of DMA vs input methods/events
Related Issue
Type of Changes
Steps (Choose relevant, delete irrelevant before submitting)
All Pull Requests
Documentation Changes
cd doc/manual/; make html) to ensure no errors.Git Logistics
git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.[x] Write short & meaningful commit messages. Review each commit for messages (
git show). Format:Licensing
See copyright & licensing for more info. ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.