[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 8/8] doc: document task_set_name
From: |
Justus Winter |
Subject: |
[PATCH 8/8] doc: document task_set_name |
Date: |
Sat, 1 Feb 2014 15:09:28 +0100 |
* doc/mach.texi (Task Information): Document the new task_set_name
procedure.
---
doc/mach.texi | 11 +++++++++++
1 file changed, 11 insertions(+)
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
--
1.8.5.2
- Re: [PATCH 3/8] kern: add a name field to struct task, (continued)
[PATCH 8/8] doc: document task_set_name,
Justus Winter <=
Re: [PATCH 1/8] kern: fix printing of kmem_cache names, Samuel Thibault, 2014/02/01