doc: Specify that string memory must be freed

Specify that the caller of `get_session_name()` must explicitly free the
memory associated with the returned string.

Historically this software was written in C. C programmers have the
reflex to assume they are responsible for freeing memory. However, now
that this project is mixed C/C++ and is transitioning towards C++ the
assumption that developers will automatically know to free memory
(according to C programming conventions) does not hold as well. For this
reason, clarify that memory must be explicitly freed by the function
caller.

There are other C functions in this software that return variables that
must explicitly be freed by the caller. However, these changes have not
been applied consistently to all these cases. The assumption is that
this individual clarification still reduces confusion even if not
applied consistently.

Change-Id: I72d3568b5c1a7d8b7ff9b3d241bca1c5c55e47c1
Signed-off-by: Erica Bugden <ebugden@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/src/bin/lttng/utils.cpp b/src/bin/lttng/utils.cpp
index 7831ae65a4f695befc4a5448cafe435cf6220e3d..e57bd1b550b8119e3342db5334249bc33e1cf339 100644 (file)
--- a/src/bin/lttng/utils.cpp
+++ b/src/bin/lttng/utils.cpp
@@ -66,8 +66,11 @@ error:
 /*
  *  get_session_name
  *
- *  Return allocated string with the session name found in the config
- *  directory.
+ *  Return allocated string with the implicit session name (found in
+ *  the config directory).
+ *
+ *  The caller must explicitly free the memory associated with the
+ *  returned string.
  */
 char *get_session_name()
 {