X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=include%2Flttng%2Fust-error.h;h=543c894af92468283deca38bb1e217c9213b2d4a;hb=7075c5a2f8f4f90a018d7d1ea8c6dadda609495d;hp=8681cb04f209dbc7b36d8cccf388b17b13c68f98;hpb=a834901f2890deadb815d7f9e3ab79c3ba673994;p=lttng-ust.git

diff --git a/include/lttng/ust-error.h b/include/lttng/ust-error.h
index 8681cb04..543c894a 100644
--- a/include/lttng/ust-error.h
+++ b/include/lttng/ust-error.h
@@ -1,30 +1,13 @@
-#ifndef _LTTNG_UST_ERROR_H
-#define _LTTNG_UST_ERROR_H
-
 /*
- * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
- *                      Julien Desfossez <julien.desfossez@polymtl.ca>
- *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; only
- * version 2.1 of the License.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
+ * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  */
 
-/*
- * This header is meant for liblttng and libust internal use ONLY.
- * These declarations should NOT be considered stable API.
- */
+#ifndef _LTTNG_UST_ERROR_H
+#define _LTTNG_UST_ERROR_H
 
 #include <limits.h>
 #include <unistd.h>
@@ -58,10 +41,13 @@ enum lttng_ust_error_code {
 };
 
 /*
- * Return a human-readable error message for an lttng-ust error code.
- * code must be a positive value (or 0).
+ * lttng_ust_strerror
+ * @code: must be a negative value of enum lttng_ust_error_code (or 0).
+ *
+ * Returns a ptr to a string representing a human readable error code from the
+ * ustcomm_return_code enum.
  */
-extern const char *lttng_ust_strerror(int code);
+const char *lttng_ust_strerror(int code);
 
 #ifdef __cplusplus
 }