Alan-Jowett / sonde / 26173619125
82%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 129
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 82.918%. Remained the same
26173619125

push

github

web-flow 
docs: resolve node design-vs-implementation drift (#1042)

* docs: resolve node design-vs-implementation drift (#1027)

Update
ode-design.md,
ode-validation.md, and protocol-crate-design.md
to match the current implementation, resolving all four findings from the
periodic maintenance audit:

- A1 (§2): SHA-256 technology entry now says `sha2` RustCrypto crate
  (software) instead of ESP-IDF hardware SHA peripheral.
- A2 (§13): Main task stack size updated from 16 KB to 24 KB to match
  `sdkconfig.defaults` (24576), with rationale for the headroom.
- A3 (§14): Added preamble documenting the lib + `src/bin/node.rs`
  binary target structure and `binstart` entry point mechanism.
- B1 (§8.1a): Documented `HelperDescriptor` and `HelperReturn`
  return-type tracking used by the `sonde-bpf` adapter for pointer
  provenance.

Also fixed stale cross-references:
- `protocol-crate-design.md`: corrected claim that node uses hardware
  SHA (both gateway and node use RustCrypto `sha2`).
- `node-validation.md`: updated stack size test procedures from 16384
  to 24576.

Closes #1027

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

* docs: use correct `Helper` type name in `HelperDescriptor` snippet

The `HelperDescriptor` struct is defined in `sonde-bpf` where the
function type is `Helper` (`ebpf.rs`), not the node firmware's
`HelperFn` alias.  Update the design doc snippet to match and add a
comment noting the alias equivalence.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>

---------

Signed-off-by: Alan Jowett <alan.jowett@microsoft.com>
Co-authored-by: Alan Jowett <alan.jowett@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

37740 of 45515 relevant lines covered (82.92%)

248.85 hits per line

Jobs
ID Job ID Ran Files Coverage
1 26173619125.1 129
82.92
 GitHub Action Run
Source Files on build 26173619125