diff options
| author | Justus Winter <4winter@informatik.uni-hamburg.de> | 2014-02-01 15:05:58 +0100 |
|---|---|---|
| committer | Justus Winter <4winter@informatik.uni-hamburg.de> | 2014-02-05 11:57:56 +0100 |
| commit | 61104ec0056504e675d7096e23c9de3f7fdda2ff (patch) | |
| tree | 60d0149e482599a4c5259bc329c46a9bbe6047a1 /doc | |
| parent | 877a319c94619e51a0103b9f201523b269588eb0 (diff) | |
doc: document task_set_name
* doc/mach.texi (Task Information): Document the new task_set_name
procedure.
Diffstat (limited to 'doc')
| -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 9ad9e70b..d089224d 100644 --- a/doc/mach.texi +++ b/doc/mach.texi @@ -5037,6 +5037,17 @@ total system run time for live threads This is a pointer to a @code{struct task_thread_times_info}. @end deftp +@deftypefun kern_return_t task_set_name (@w{task_t @var{target_task}}, @w{kernel_debug_name_t @var{name}}) + +The function @code{task_set_name} sets the name of @var{target_task} +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 Task Execution @subsection Task Execution |