Improve doc of `getaffinity' and `setaffinity'.
authorLudovic Courtès <ludo@gnu.org>
Tue, 7 Dec 2010 21:56:07 +0000 (22:56 +0100)
committerLudovic Courtès <ludo@gnu.org>
Tue, 7 Dec 2010 22:13:20 +0000 (23:13 +0100)
* doc/ref/posix.texi (Processes): Add cross-reference from `setaffinity'
  and `getaffinity' to the corresponding node in the glibc manual.

* libguile/posix.c (scm_getaffinity, scm_setaffinity): Likewise.

doc/ref/posix.texi
libguile/posix.c

index 7149fb6..4afc6d0 100644 (file)
@@ -1840,7 +1840,9 @@ has its corresponding bit set in the returned bitvector.
 The number of bits set is a good estimate of how many CPUs
 Guile can use without stepping on other processes' toes.
 
-Currently this procedure is only defined on GNU variants.
+Currently this procedure is only defined on GNU variants
+(@pxref{CPU Affinity, @code{sched_getaffinity},, libc, The
+GNU C Library Reference Manual}).
 @end deffn
 
 @deffn {Scheme Procedure} setaffinity pid mask
@@ -1849,7 +1851,9 @@ Install the CPU affinity mask @var{mask}, a bitvector, for
 the process or thread with ID @var{pid}.  The return value
 is unspecified.
 
-Currently this procedure is only defined on GNU variants.
+Currently this procedure is only defined on GNU variants
+(@pxref{CPU Affinity, @code{sched_setaffinity},, libc, The
+GNU C Library Reference Manual}).
 @end deffn
 
 
index 2a2a77b..652f63d 100644 (file)
@@ -1930,7 +1930,9 @@ SCM_DEFINE (scm_getaffinity, "getaffinity", 1, 0, 0,
            "has its corresponding bit set in the returned bitvector.\n"
            "The number of bits set is a good estimate of how many CPUs\n"
            "Guile can use without stepping on other processes' toes.\n\n"
-           "Currently this procedure is only defined on GNU variants.\n")
+           "Currently this procedure is only defined on GNU variants\n"
+           "(@pxref{CPU Affinity, @code{sched_getaffinity},, libc, The\n"
+           "GNU C Library Reference Manual}).\n")
 #define FUNC_NAME s_scm_getaffinity
 {
   int err;
@@ -1954,7 +1956,9 @@ SCM_DEFINE (scm_setaffinity, "setaffinity", 2, 0, 0,
            "Install the CPU affinity mask @var{mask}, a bitvector, for\n"
            "the process or thread with ID @var{pid}.  The return value\n"
            "is unspecified.\n\n"
-           "Currently this procedure is only defined on GNU variants.\n")
+           "Currently this procedure is only defined on GNU variants\n"
+           "(@pxref{CPU Affinity, @code{sched_setaffinity},, libc, The\n"
+           "GNU C Library Reference Manual}).\n")
 #define FUNC_NAME s_scm_setaffinity
 {
   cpu_set_t cs;