summaryrefslogtreecommitdiffstats
path: root/spec/rtems/config/if/get-build-label.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/config/if/get-build-label.yml')
-rw-r--r--spec/rtems/config/if/get-build-label.yml6
1 files changed, 4 insertions, 2 deletions
diff --git a/spec/rtems/config/if/get-build-label.yml b/spec/rtems/config/if/get-build-label.yml
index 048538dc..51937ece 100644
--- a/spec/rtems/config/if/get-build-label.yml
+++ b/spec/rtems/config/if/get-build-label.yml
@@ -11,7 +11,9 @@ definition:
return: const char *
variants: []
description: |
- The build label is a user-provided string defined by the build configuration.
+ 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
@@ -37,6 +39,6 @@ notes: |
params: []
return:
return: |
- Returns the pointer to the RTEMS build label.
+ Returns a pointer to the RTEMS build label.
return-values: []
type: interface