svn commit: r249183 - projects/counters/share/man/man9

[Gleb Smirnoff]

Author: glebius
Date: Sat Apr  6 07:10:54 2013
New Revision: 249183
URL: http://svnweb.freebsd.org/changeset/base/249183

Log:
  Wording.
  
  Submitted by:	bde

Modified:
  projects/counters/share/man/man9/counter.9

Modified: projects/counters/share/man/man9/counter.9
==============================================================================
--- projects/counters/share/man/man9/counter.9	Sat Apr  6 06:02:55 2013	(r249182)
+++ projects/counters/share/man/man9/counter.9	Sat Apr  6 07:10:54 2013	(r249183)
@@ -37,19 +37,19 @@
 .Ft counter_u64_t
 .Fn counter_u64_alloc "int wait"
 .Ft void
-.Fn counter_u64_free "counter_u64_t cnt"
+.Fn counter_u64_free "counter_u64_t c"
 .Ft void
-.Fn counter_u64_add "counter_u64_t cnt" "int64_t value"
+.Fn counter_u64_add "counter_u64_t c" "int64_t v"
 .Ft void
 .Fn counter_enter
 .Ft void
 .Fn counter_exit
 .Ft void
-.Fn counter_u64_add_protected "counter_u64_t cnt" "int64_t value"
+.Fn counter_u64_add_protected "counter_u64_t c" "int64_t v"
 .Ft uint64_t
-.Fn counter_u64_fetch "counter_u64_t cnt"
+.Fn counter_u64_fetch "counter_u64_t c"
 .Ft void
-.Fn counter_u64_zero "counter_u64_t cnt"
+.Fn counter_u64_zero "counter_u64_t c"
 .In sys/sysctl.h
 .Fn SYSCTL_COUNTER_U64 parent nbr name access ptr val descr
 .Fn SYSCTL_ADD_COUNTER_U64 ctx parent nbr name access ptr descr
@@ -92,17 +92,15 @@ or
 If
 .Va M_WAITOK
 is specified the operation may fail.
-.It Fn counter_u64_free cnt
-Free previously allocated
-.Nm
-.Fa cnt .
-.It Fn counter_u64_add cnt value
+.It Fn counter_u64_free c
+Free the previously allocated counter
+.Fa c .
+.It Fn counter_u64_add c v
 Add
-.Fa value
-to the
-.Nm
-.Fa cnt .
-The KPI does not guarantee any protection from underflow.
+.Fa v
+to
+.Fa c .
+The KPI does not guarantee any protection from wraparound.
 .It Fn counter_enter
 Enter mode that would allow to safely update several counters via
 .Fn counter_u64_add_protected .
@@ -113,22 +111,20 @@ See
 .Sx IMPLEMENTATION DETAILS .
 .It Fn counter_exit
 Exit mode for updating several counters.
-.It Fn counter_u64_add_protected cnt value
+.It Fn counter_u64_add_protected c v
 Same as
 .Fn counter_u64_add ,
 but should be preceded by
 .Fn counter_enter .
-.It Fn counter_u64_fetch cnt
-Obtain current snapshot of the data collected in
-.Nm
-.Fa cnt .
+.It Fn counter_u64_fetch c
+Take a snapshot of counter
+.Fa c .
 The data obtained is not guaranteed to reflect the real cumulative
 value for any moment.
-.It Fn counter_u64_zero cnt
-Clear data collected in
-.Nm
-.Fa cnt
-and set its value to zero.
+.It Fn counter_u64_zero c
+Clear the counter
+.Fa c
+and set it to zero.
 .It Fn SYSCTL_COUNTER_U64 parent nbr name access ptr val descr
 Declare a static
 .Xr sysctl