Page MenuHomeFreeBSD

ithread(9): update functions to current day
ClosedPublic

Authored by mhorne on Dec 15 2021, 5:25 PM.
Tags
None
Referenced Files
Unknown Object (File)
Dec 25 2023, 3:08 AM
Unknown Object (File)
Dec 20 2023, 5:26 AM
Unknown Object (File)
Nov 18 2023, 11:18 PM
Unknown Object (File)
Nov 15 2023, 2:54 PM
Unknown Object (File)
Nov 9 2023, 8:16 PM
Unknown Object (File)
Nov 7 2023, 7:34 PM
Unknown Object (File)
Oct 17 2023, 10:06 PM
Unknown Object (File)
Oct 8 2023, 7:01 PM

Details

Summary

The public KPI is now intr_event_**,

  • Convert existing documented functions to their equivalents.
  • Fix up the function arguments
  • Fix up the possible error return values for each
  • Remove ithread_schedule() completely
  • Fix up MLINKS

Future changes will update the descriptive text for these functions, and
add documentation for some of the newer functions that are missing.

PR: 100803
Based on work by: trhodes, ygy

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

share/man/man9/Makefile
1322–1326

I was thinking we'd keep ithread.9, but maybe it doesn't really make sense to do so.

I think it is fine to ditch ithread.9 and just have intr_event.9.

This revision is now accepted and ready to land.Dec 15 2021, 7:53 PM
pauamma_gundo.com added inline comments.
share/man/man9/intr_event.9
91

Is "entr" a typo for "intr"?

105
113

Since you're touching that area, "an interrupt thread" should be "the interrupt thread" here, if you're referring to the same one mentioned on the previous line.

Fix small nits, rename page to intr_event.9

This revision now requires review to proceed.Sep 6 2022, 8:46 PM
This revision is now accepted and ready to land.Sep 30 2022, 8:58 PM

A few nits, but this is way beyond me.

share/man/man9/intr_event.9
26–27

Reminder (if needed) to bump on commit.

203

While there, maybe change this to .Xr swi_add 9 to make it clearer it's not just an example and for easier comprehension of what the example does, not just how it does it? (I'm not part of the intended audience, so if you feel it's not needed, that's fine with me.)

share/man/man9/socket.9
174

Maybe .Xr intr_event 9?

mhorne added inline comments.
share/man/man9/intr_event.9
26–27

Yes, will do.

203

Sure, it will be done as part of D33476.

share/man/man9/socket.9
174

I wanted to retain the reference, but I did not find a way to word it that makes sense. "intr_event" is the new name of the KPI, but you wouldn't really refer to an object as an "intr_event" in the same way that you can with an "ithread".

This revision was automatically updated to reflect the committed changes.
mhorne marked 2 inline comments as done.