[rtems commit] Document RTEMS_DEFINE_GLOBAL_SYMBOL_IN_SECTION()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    4fcc53a06951d727d9c778381d6c0229c6b572ee
Changeset: http://git.rtems.org/rtems/commit/?id=4fcc53a06951d727d9c778381d6c0229c6b572ee

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Nov 25 10:38:42 2019 +0100

Document RTEMS_DEFINE_GLOBAL_SYMBOL_IN_SECTION()

---

 cpukit/include/rtems/score/basedefs.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/cpukit/include/rtems/score/basedefs.h b/cpukit/include/rtems/score/basedefs.h
index 5f38559..4589bea 100644
--- a/cpukit/include/rtems/score/basedefs.h
+++ b/cpukit/include/rtems/score/basedefs.h
@@ -347,7 +347,8 @@
  * @brief Defines a global symbol with the specified name in the specified
  * section.
  *
- * The name must be a valid designator.
+ * The name must be a valid designator.  The alignment of the symbol depends on
+ * the current location counter of the section.
  */
 #if defined(__GNUC__)
   #define RTEMS_DEFINE_GLOBAL_SYMBOL_IN_SECTION( _name, _section ) \