From 61104ec0056504e675d7096e23c9de3f7fdda2ff Mon Sep 17 00:00:00 2001
From: Justus Winter <4winter@informatik.uni-hamburg.de>
Date: Sat, 1 Feb 2014 15:05:58 +0100
Subject: doc: document task_set_name

* doc/mach.texi (Task Information): Document the new task_set_name
procedure.
---
 doc/mach.texi | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'doc/mach.texi')

diff --git a/doc/mach.texi b/doc/mach.texi
index 9ad9e70..d089224 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
-- 
cgit v1.2.3