siftr: add documentation to man page
ClosedPublic
Actions

Authored by tuexen on Jun 30 2023, 12:20 PM.

Details

Reviewers

cc
rscheff
gnn
pauamma_gundo.com

Group Reviewers

manpages

Commits

rGce581fb02fc1: siftr: document siftr probe to man page of the tcp provider
rG0631830a7a3c: siftr: document siftr probe to man page of the tcp provider

Summary

The man page of the dtrace TCP provider was missing the description of the siftr probe. This patch add this for the current version in the siftr.d file. This is not working on head, but in stable/13. So this patch can be MFCed to stable/13. Upcoming fixes to siftr.d to get it working again in head will update this man page again, but changes mit not be MFCed.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

tuexen created this revision.Jun 30 2023, 12:20 PM

Herald added a reviewer: gnn. · View Herald TranscriptJun 30 2023, 12:20 PM

Herald added a subscriber: imp. · View Herald Transcript

tuexen requested review of this revision.Jun 30 2023, 12:20 PM

cc requested changes to this revision.Jun 30 2023, 2:44 PM

cc added inline comments.

share/man/man4/dtrace_tcp.4
316	This "ipver" does not seem to be the field in siftr from fbsd13. Also it looks, for example, the timestamp, local/foreign ip address fields are missing, based on https://man.freebsd.org/cgi/man.cgi?query=siftr. Also slow start threshold field should be ahead of congestion window field, etc. There are more fields missing or not in the same order. Please check and sync with the siftr Field descriptions in the link mentioned above.
492	"RPORT" shall be "FPORT"?

This revision now requires changes to proceed.Jun 30 2023, 2:44 PM

tuexen added inline comments.Jun 30 2023, 8:29 PM

share/man/man4/dtrace_tcp.4
316	I'm documenting `struct siftrinfo` from siftr.d. I'm documenting the fields in the order they are contained in the structure. These fields are not in the order of the output of the `siftr` module. I just document what is there. In particular the local/remote addresses are missing and I'm planning to add them in a later commit and then document them. But right now, there are not there and therefore can't be documented. The only field I'm no documenting is the `tval` field, since there is no translator for it and `dtrace` has its own way of time stamping.
492	The other probes of the tcp provider use local/remote. I have a cleanup patch which will change to that convention. But If you prefer, I can change it to `FPORT`, MFC that to stable/13 and than change it to local/remote instead of local/foreign. This is of course only for the dtrace probe.