summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/config.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-23 10:58:56 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-25 16:16:16 +0100
commitd8bfa5a9bc3f691c0bfda89de8d6f17eca5bd327 (patch)
tree05c4907e959067ced0d5ebb255900d0049f069cf /cpukit/include/rtems/config.h
parentconfig: Adjust stack allocator initialization (diff)
downloadrtems-d8bfa5a9bc3f691c0bfda89de8d6f17eca5bd327.tar.bz2
rtems: Add rtems_get_build_label()
Update #4269.
Diffstat (limited to 'cpukit/include/rtems/config.h')
-rw-r--r--cpukit/include/rtems/config.h33
1 files changed, 32 insertions, 1 deletions
diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h
index a3eec39584..2f1a7ecfa4 100644
--- a/cpukit/include/rtems/config.h
+++ b/cpukit/include/rtems/config.h
@@ -10,7 +10,7 @@
*/
/*
- * Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 2009, 2021 embedded brains GmbH (http://www.embedded-brains.de)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@@ -93,6 +93,37 @@ extern "C" {
* configuration option values, for example rtems_resource_unlimited().
*/
+/* Generated from spec:/rtems/config/if/get-build-label */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the RTEMS build label.
+ *
+ * The build label is a user-provided string defined by the build
+ * configuration.
+ *
+ * @return Returns the pointer to the RTEMS build label.
+ *
+ * @par Notes
+ * The build label can be used to distinguish test suite results obtained from
+ * different build configurations. A use case is to record test results with
+ * performance data to track performance regressions. For this a database of
+ * performance limits is required. The build label and the target hash
+ * obtained from rtems_get_target_hash() can be used as a key to obtain
+ * performance limits.
+ *
+ * @par Constraints
+ * @parblock
+ * The following constraints apply to this directive:
+ *
+ * * The directive may be called from within any runtime context.
+ *
+ * * The directive will not cause the calling task to be preempted.
+ * @endparblock
+ */
+const char *rtems_get_build_label( void );
+
/* Generated from spec:/rtems/config/if/get-copyright-notice */
/**