diff mbox series

[API-NEXT,PATCHv4,4/4] doc: userguide: add odp_timer_capability() section to user guide

Message ID 1486521424-11172-5-git-send-email-kevin.wang@linaro.org
State New
Headers show
Series a new API to support timer capability | expand

Commit Message

Kevin Wang Feb. 8, 2017, 2:37 a.m. UTC
Signed-off-by: Kevin Wang <kevin.wang@linaro.org>

---
 doc/users-guide/users-guide-timer.adoc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

-- 
1.9.1

Comments

Maxim Uvarov Feb. 16, 2017, 7:07 p.m. UTC | #1
On 02/08/17 05:37, Kevin Wang wrote:
> Signed-off-by: Kevin Wang <kevin.wang@linaro.org>

> ---

>  doc/users-guide/users-guide-timer.adoc | 3 ++-

>  1 file changed, 2 insertions(+), 1 deletion(-)

> 

> diff --git a/doc/users-guide/users-guide-timer.adoc b/doc/users-guide/users-guide-timer.adoc

> index 9cd30de..ccca7d4 100644

> --- a/doc/users-guide/users-guide-timer.adoc

> +++ b/doc/users-guide/users-guide-timer.adoc

> @@ -6,7 +6,8 @@ timing features found in various platforms that support ODP implementations.

>  Timers are drawn from specialized pools called _timer pools_ that have their

>  own abstract type (`odp_timer_pool_t`). Each timer pool is a logically

>  independent time source with its own _resolution_ measured in nanoseconds (ns)

> -and a maximum number of timers that it can support. Applications can have many

> +and a maximum number of timers that it can support. The max _resolution_ is

> +able to be obtained from `odp_timer_capability()`. 



Is it max resolution or min resolution? I think it's better to declare
it as best timer resolution or timer accuracy.


 Applications can have many
>  timers active at the same time and can set them to use either relative or

>  absolute time. Associated with each timer is a queue that is to receive events

>  when this timer expires. This queue is created by a separate

>
diff mbox series

Patch

diff --git a/doc/users-guide/users-guide-timer.adoc b/doc/users-guide/users-guide-timer.adoc
index 9cd30de..ccca7d4 100644
--- a/doc/users-guide/users-guide-timer.adoc
+++ b/doc/users-guide/users-guide-timer.adoc
@@ -6,7 +6,8 @@  timing features found in various platforms that support ODP implementations.
 Timers are drawn from specialized pools called _timer pools_ that have their
 own abstract type (`odp_timer_pool_t`). Each timer pool is a logically
 independent time source with its own _resolution_ measured in nanoseconds (ns)
-and a maximum number of timers that it can support. Applications can have many
+and a maximum number of timers that it can support. The max _resolution_ is
+able to be obtained from `odp_timer_capability()`.  Applications can have many
 timers active at the same time and can set them to use either relative or
 absolute time. Associated with each timer is a queue that is to receive events
 when this timer expires. This queue is created by a separate