Move to kernel style SPDX license identifiers

[lttng-tools.git] / include / lttng / condition / evaluation.h

diff --git a/include/lttng/condition/evaluation.h b/include/lttng/condition/evaluation.h
index 987fce32bda9af0c8c1bbdf0c096d47cfb2caf61..4ae1c62d9c09b1a0eabe864ba29724b9a72854ba 100644 (file)
--- a/include/lttng/condition/evaluation.h
+++ b/include/lttng/condition/evaluation.h
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@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, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * 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.
- *
- * 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
  */
 
 #ifndef LTTNG_EVALUATION_H
@@ -30,13 +20,22 @@ enum lttng_evaluation_status {
        LTTNG_EVALUATION_STATUS_OK = 0,
        LTTNG_EVALUATION_STATUS_ERROR = -1,
        LTTNG_EVALUATION_STATUS_INVALID = -2,
-       LTTNG_EVALUATION_STATUS_UNKNOWN = -2,
-       LTTNG_EVALUATION_STATUS_UNSET = -3,
+       LTTNG_EVALUATION_STATUS_UNKNOWN = -3,
+       LTTNG_EVALUATION_STATUS_UNSET = -4,
 };
 
+/*
+ * Get the condition type associated with an evaluation.
+ *
+ * Returns the type of a condition on success, LTTNG_CONDITION_TYPE_UNKNOWN on
+ * error.
+ */
 extern enum lttng_condition_type lttng_evaluation_get_type(
                const struct lttng_evaluation *evaluation);
 
+/*
+ * Destroy (frees) an evaluation object.
+ */
 extern void lttng_evaluation_destroy(struct lttng_evaluation *evaluation);
 
 #ifdef __cplusplus