cpukit: deprecate rtems_clock_get(). closes #2294.

This commit is contained in:
Gedare Bloom
2015-03-10 13:51:21 -04:00
parent 3ac681191e
commit 23e43f6af1
2 changed files with 6 additions and 1 deletions

View File

@@ -77,6 +77,9 @@ typedef TOD_Nanoseconds_since_last_tick_routine
/** /**
* @brief Obtain Current Time of Day * @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 * This routine implements the rtems_clock_get directive. It returns
* one of the following: * one of the following:
* + current time of day * + current time of day
@@ -94,7 +97,7 @@ typedef TOD_Nanoseconds_since_last_tick_routine
rtems_status_code rtems_clock_get( rtems_status_code rtems_clock_get(
rtems_clock_get_options option, rtems_clock_get_options option,
void *time_buffer void *time_buffer
); ) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
/** /**
* @brief Obtain Current Time of Day (Classic TOD) * @brief Obtain Current Time of Day (Classic TOD)

View File

@@ -319,6 +319,8 @@ procedure Clock_Get (
@subheading DESCRIPTION: @subheading DESCRIPTION:
This directive is deprecated.
This directive obtains the system date and time. If This directive obtains the system date and time. If
the caller is attempting to obtain the date and time (i.e. 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}, option is set to either @code{@value{RPREFIX}CLOCK_GET_SECONDS_SINCE_EPOCH},