diff options
| author | Samuel Thibault <samuel.thibault@ens-lyon.org> | 2024-02-12 18:55:23 +0100 |
|---|---|---|
| committer | Samuel Thibault <samuel.thibault@ens-lyon.org> | 2024-02-12 18:55:23 +0100 |
| commit | 744e84302311df9eec9452936a26b16d8649c384 (patch) | |
| tree | 721ae6743cdfef1213b26762f89547f0086fca60 | |
| parent | 10b25803ce879ee6ac832b884bfdabc79769486a (diff) | |
Add documentation for thread_set_name
| -rw-r--r-- | doc/mach.texi | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/mach.texi b/doc/mach.texi index d0f56eca..f85288e0 100644 --- a/doc/mach.texi +++ b/doc/mach.texi @@ -4427,6 +4427,17 @@ The last processor used by the thread. This is a pointer to a @code{struct thread_sched_info}. @end deftp +@deftypefun kern_return_t thread_set_name (@w{thread_t @var{target_thread}}, @w{const_kernel_debug_name_t @var{name}}) + +The function @code{thread_set_name} sets the name of @var{target_thread} +to @var{name}, truncating it if necessary. + +This is a debugging aid. The name is used in diagnostic messages +printed by the kernel. + +The function returns @code{KERN_SUCCESS} if the call succeeded. +@end deftypefun + @node Thread Settings @subsection Thread Settings |