Docs: Document Agent reply codes

[lttng-tools.git] / src / common / sessiond-comm / agent.h

diff --git a/src/common/sessiond-comm/agent.h b/src/common/sessiond-comm/agent.h
index 93ef7ac093e2fe241b44d31c5a6a4640ca35911c..b562b7402baaf6c9d5ec88ce50544e73b7514524 100644 (file)
--- a/src/common/sessiond-comm/agent.h
+++ b/src/common/sessiond-comm/agent.h
@@ -24,7 +24,7 @@
 #include <lttng/lttng.h>
 
 /*
- * Command value pass in the header.
+ * Command value passed in the header.
  */
 enum lttcomm_agent_command {
        AGENT_CMD_LIST       = 1,
@@ -34,12 +34,16 @@ enum lttcomm_agent_command {
 };
 
 /*
- * Return code from the Java agent.
+ * Return codes from the agent.
  */
 enum lttcomm_agent_ret_code {
+       /* Success, assumed to be the first entry */
        AGENT_RET_CODE_SUCCESS      = 1,
+       /* Invalid command */
        AGENT_RET_CODE_INVALID      = 2,
+       /* Unknown logger name */
        AGENT_RET_CODE_UNKNOWN_NAME = 3,
+       AGENT_RET_CODE_NR,
 };
 
 /*
@@ -68,7 +72,7 @@ struct lttcomm_agent_disable {
 } LTTNG_PACKED;
 
 /*
- * Generic reply coming from the Java Agent.
+ * Generic reply coming from the agent.
  */
 struct lttcomm_agent_generic_reply {
        uint32_t ret_code;
@@ -83,7 +87,7 @@ struct lttcomm_agent_list_reply_hdr {
 } LTTNG_PACKED;
 
 /*
- * List command reply payload coming from the Java Agent.
+ * List command reply payload coming from the agent.
  */
 struct lttcomm_agent_list_reply {
        uint32_t nb_event;