Prepare code to plug the overcommit notification.

[~madcoder/pwqr.git] / Documentation / pwqr.adoc

diff --git a/Documentation/pwqr.adoc b/Documentation/pwqr.adoc
index 0c04746..1942097 100644 (file)
--- a/Documentation/pwqr.adoc
+++ b/Documentation/pwqr.adoc
@@ -213,9 +213,8 @@ Valid values for the `op` argument are:
        value is passed as the `val` argument. The requests returns the old
        concurrency level on success.
 +
        value is passed as the `val` argument. The requests returns the old
        concurrency level on success.
 +

-       A zero or negative value for `val` means 'automatic' and is recomputed
-       as the current number of online CPUs as
-       `sysconf(_SC_NPROCESSORS_ONLN)` would return.
+A zero or negative value for `val` means 'automatic' and is recomputed as the
+current number of online CPUs as `sysconf(_SC_NPROCESSORS_ONLN)` would return.

 
 `PWQR_REGISTER`::
        Registers the calling thread to be taken into account by the pool
 
 `PWQR_REGISTER`::
        Registers the calling thread to be taken into account by the pool


@@ -258,6 +257,9 @@ If the concurrency level is below the target, then the kernel checks if the
 address `addr` still contains the value `val` (in the fashion of `futex(2)`).
 If it doesn't then the call doesn't block. Else the calling thread is blocked
 until a `PWQR_WAKE` command is received.
 address `addr` still contains the value `val` (in the fashion of `futex(2)`).
 If it doesn't then the call doesn't block. Else the calling thread is blocked
 until a `PWQR_WAKE` command is received.

++
+`addr` must of course be a pointer to an aligned integer which stores the
+reference ticket in userland.

 
 `PWQR_PARK`::
        Puts the thread in park mode. Those are spare threads to avoid
 
 `PWQR_PARK`::
        Puts the thread in park mode. Those are spare threads to avoid