blob: bd15df09bc369e78f6939b5d26241e940bccae9a (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
Gets the RTEMS build label.
copyrights:
- Copyright (C) 2021 embedded brains GmbH & Co. KG
definition:
default:
attributes: null
body: null
params: []
return: const char *
variants: []
description: |
The build label is a user-provided string defined by the build configuration
through the ``RTEMS_BUILD_LABEL`` build option. The format of the string is
completely user-defined.
enabled-by: true
index-entries: []
interface-type: function
links:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
- role: constraint
uid: /constraint/directive-not-pre-qualified
- role: constraint
uid: /constraint/directive-ctx-any
- role: constraint
uid: /constraint/directive-no-preempt
name: rtems_get_build_label
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 ${get-target-hash:/name} can be used as a key to obtain performance
limits.
params: []
return:
return: |
Returns a pointer to the RTEMS build label.
return-values: []
type: interface
|