Mats Petersson
2013-Jan-18 14:38 UTC
[PATCH V3] Add documentation comment to get_domain_by_id
Fixed removing blank line problem from moving comment around...
Signed-off-by: Mats Petersson <mats.petersson@citrix.com>
---
xen/include/xen/sched.h | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/xen/include/xen/sched.h b/xen/include/xen/sched.h
index 90a6537..9208c99 100644
--- a/xen/include/xen/sched.h
+++ b/xen/include/xen/sched.h
@@ -509,6 +509,16 @@ static inline struct domain *rcu_lock_current_domain(void)
return /*rcu_lock_domain*/(current->domain);
}
+/*
+ * This function finds a domain from a domain id. The domain''s
+ * reference count is incremented as part of this function.
+ * The caller must call put_domain to un-reference the domain.
+ *
+ * dom Domain ID of the domain to be found.
+ *
+ * return On success the pointer to a struct domain.
+ * On failure, return NULL.
+ */
struct domain *get_domain_by_id(domid_t dom);
void domain_destroy(struct domain *d);
int domain_kill(struct domain *d);
--
1.7.9.5