aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/misc.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/src/misc.rst b/docs/src/misc.rst
index 7cfac85f..d9bf3aef 100644
--- a/docs/src/misc.rst
+++ b/docs/src/misc.rst
@@ -244,6 +244,15 @@ API
.. c:function:: char** uv_setup_args(int argc, char** argv)
Store the program arguments. Required for getting / setting the process title.
+ Libuv may take ownership of the memory that `argv` points to. This function
+ should be called exactly once, at program start-up.
+
+ Example:
+
+ ::
+
+ argv = uv_setup_args(argc, argv); /* May return a copy of argv. */
+
.. c:function:: int uv_get_process_title(char* buffer, size_t size)