Document some exported Sys CPU stuff #31204
Conversation
|
You are the best, @kshyatt. |
|
|
||
| Print a summary of information about each processor in `cpu` gathered from [`cpu_info](@ref). This is generally: | ||
| - The number (e.g. CPU 3 on a system with 10 total) | ||
| - The CPU model |
There was a problem hiding this comment.
Perhaps put this first since it is the first thing to show
| """ | ||
| Sys.cpu_info() | ||
|
|
||
| Gather information about all CPUs in the system through a syscall using LibUV. |
There was a problem hiding this comment.
libuv is usually in lowercase but I am not sure it is needed in the docstring at all.
We dont have any documentation about the type of struct getting returned CPUinfo, so there isn't really any useful thing you can do with the return value here. Arguably this should just not be exported (which is breaking).
There was a problem hiding this comment.
Should we doc it for now then remove the export in the future?
There was a problem hiding this comment.
| Gather information about all CPUs in the system through a syscall using LibUV. | |
| Gather information about the logical CPU cores in the system. This includes: | |
| - The model name | |
| - The clock speed | |
| - The amount of time spent in `user`, `nice`, `sys`, `idle`, and `irq` modes |
(and drop the corresponding list from Sys.cpu_summary)
Co-Authored-By: kshyatt <[email protected]>
Co-Authored-By: kshyatt <[email protected]>
|
@KristofferC did you have any thoughts about the export issue and the explanation about "e.g."? |
Co-Authored-By: kshyatt <[email protected]>
|
Since CI failed during doc-build on this PR on previous commits it would be good to not ci-skip and run CI before merging. |
|
@fredrikekre my plan was to squash-and-merge and force push manually with no ci skipping once we settle on things |
| """ | ||
| Sys.cpu_info() | ||
|
|
||
| Gather information about all CPUs in the system through a syscall using LibUV. |
There was a problem hiding this comment.
| Gather information about all CPUs in the system through a syscall using LibUV. | |
| Gather information about the logical CPU cores in the system. This includes: | |
| - The model name | |
| - The clock speed | |
| - The amount of time spent in `user`, `nice`, `sys`, `idle`, and `irq` modes |
(and drop the corresponding list from Sys.cpu_summary)
StefanKarpinski
added
the
forget me not
This reverts commit 7f2922e.
simeonschaub
removed
the
forget me not
Can't help but attack #26919 when I should be doing other things...