[rtems commit] cpukit: deprecate rtems_clock_get(). closes #2294.

Gedare Bloom gedare at rtems.org
Tue Mar 10 20:20:34 UTC 2015


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

Author:    Gedare Bloom <gedare at rtems.org>
Date:      Tue Mar 10 13:51:21 2015 -0400

cpukit: deprecate rtems_clock_get(). closes #2294.

---

 cpukit/rtems/include/rtems/rtems/clock.h | 5 ++++-
 doc/user/clock.t                         | 2 ++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index 7595f5e..2a1c772 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/cpukit/rtems/include/rtems/rtems/clock.h
@@ -77,6 +77,9 @@ typedef TOD_Nanoseconds_since_last_tick_routine
 /**
  * @brief Obtain Current Time of Day
  *
+ * @deprecated rtems_clock_get() is deprecated. Use the more explicit
+ * function calls rtems_clock_get_xxx().
+ *
  * This routine implements the rtems_clock_get directive. It returns
  * one of the following:
  * + current time of day
@@ -94,7 +97,7 @@ typedef TOD_Nanoseconds_since_last_tick_routine
 rtems_status_code rtems_clock_get(
   rtems_clock_get_options  option,
   void                    *time_buffer
-);
+) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
 
 /**
  * @brief Obtain Current Time of Day (Classic TOD)
diff --git a/doc/user/clock.t b/doc/user/clock.t
index 1e821ad..f67003c 100644
--- a/doc/user/clock.t
+++ b/doc/user/clock.t
@@ -319,6 +319,8 @@ procedure Clock_Get (
 
 @subheading DESCRIPTION:
 
+This directive is deprecated.
+
 This directive obtains the system date and time.  If
 the caller is attempting to obtain the date and time (i.e.
 option is set to either @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH},



More information about the vc mailing list