c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: mention step-by-step design document

Browse Source 
This commit changes the README of `./internal` to make
sure we're referring to the step-by-step design doc.
This commit is contained in:
Simone Basso 2022-06-17 11:02:54 +02:00 committed by GitHub
parent c3fb7308d8
commit 28585fbdc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
internal/README.md
View File

@ -41,12 +41,17 @@ to bootstrap OONI probe and perform measurements;
We originally implemented these functionality into a separate We originally implemented these functionality into a separate
repository: [ooni/netx](https://github.com/ooni/netx). The repository: [ooni/netx](https://github.com/ooni/netx). The
original [design document](https://github.com/ooni/netx/blob/master/DESIGN.md) original [design document](../docs/design/dd-002-netx.md)
still provides a good overview of the problems we wanted to solve. still provides a good overview of the problems we wanted to solve.
The newer [dd-002-step-by-step.md](../docs/design/dd-003-step-by-step.md)
design document describes the current architecture (as of 2022-06-17)
and the future trajectory for `netx`.
The general idea was to provide interfaces replacing standard library The general idea of `netx` has always been to provide interfaces replacing
objects that we could further wrap to perform network measurements without standard library objects that we could further wrap to perform network
deviating from the normal APIs expected by Go programmers. For example, measurements without deviating from the normal APIs expected by Go programmers.
For example,
```Go ```Go
type Dialer interface { type Dialer interface {
@ -106,3 +111,4 @@ and inside `netxlite` or other packages. We are currently experimenting
with step-by-step measurements, an alternative measurement with step-by-step measurements, an alternative measurement
approach where we break down operations in simpler building blocks. This approach where we break down operations in simpler building blocks. This
alternative approach may eventually make `netx` obsolete. alternative approach may eventually make `netx` obsolete.