From: Raphaël Beamonte <raphael.beamonte@gmail.com>
Date: Mon, 27 Feb 2012 22:37:18 +0000 (-0500)
Subject: Fix documentation in lttng.h
X-Git-Tag: v2.0.0-rc2~21
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=c8f61fc6a881c402df23844b5311d3ff0178df79;p=lttng-tools.git

Fix documentation in lttng.h

Some functions in lttng.h are not aimed to be used only for kernel but
also for UST. This patch changes only the references made to 'kernel' to
make the documentation generic in the comments.

(closes #126)

Signed-off-by: David Goulet <dgoulet@efficios.com>
---

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index 065caee91..05ba6d3a8 100644
--- a/include/lttng/lttng.h
+++ b/include/lttng/lttng.h
@@ -416,7 +416,7 @@ extern int lttng_add_context(struct lttng_handle *handle,
 		const char *channel_name);
 
 /*
- * Create or enable a kernel event (or events) for a channel.
+ * Create or enable an event (or events) for a channel.
  *
  * If the event you are trying to enable does not exist, it will be created,
  * else it is enabled.
@@ -427,14 +427,14 @@ extern int lttng_enable_event(struct lttng_handle *handle,
 		struct lttng_event *ev, const char *channel_name);
 
 /*
- * Create or enable a kernel channel.
+ * Create or enable a channel.
  * The channel name cannot be NULL.
  */
 extern int lttng_enable_channel(struct lttng_handle *handle,
 		struct lttng_channel *chan);
 
 /*
- * Disable kernel event(s) of a channel and domain.
+ * Disable event(s) of a channel and domain.
  *
  * If event_name is NULL, all events are disabled.
  * If channel_name is NULL, the default channel is used (channel0).
@@ -443,7 +443,7 @@ extern int lttng_disable_event(struct lttng_handle *handle,
 		const char *name, const char *channel_name);
 
 /*
- * Disable kernel channel.
+ * Disable channel.
  *
  * The channel name cannot be NULL.
  */