1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-30 00:40:20 +02:00

getaffinity, setaffinity docstring cleanup

* libguile/posix.c (scm_getaffinity, scm_setaffinity): Clean up
  docstrings.  Obviously if you have the function, you don't need to be
  told that you have it in the docstring.
This commit is contained in:
Andy Wingo 2016-07-11 22:17:59 +02:00
parent 2247a56d5d
commit 2ef67d08ef

View file

@ -1957,7 +1957,6 @@ SCM_DEFINE (scm_setpriority, "setpriority", 3, 0, 0,
#endif /* HAVE_SETPRIORITY */ #endif /* HAVE_SETPRIORITY */
#ifdef HAVE_SCHED_GETAFFINITY #ifdef HAVE_SCHED_GETAFFINITY
static SCM static SCM
cpu_set_to_bitvector (const cpu_set_t *cs) cpu_set_to_bitvector (const cpu_set_t *cs)
{ {
@ -1982,10 +1981,7 @@ SCM_DEFINE (scm_getaffinity, "getaffinity", 1, 0, 0,
"process @var{pid}. Each CPU the process has affinity with\n" "process @var{pid}. Each CPU the process has affinity with\n"
"has its corresponding bit set in the returned bitvector.\n" "has its corresponding bit set in the returned bitvector.\n"
"The number of bits set is a good estimate of how many CPUs\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" "Guile can use without stepping on other processes' toes.")
"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 #define FUNC_NAME s_scm_getaffinity
{ {
int err; int err;
@ -1999,19 +1995,14 @@ SCM_DEFINE (scm_getaffinity, "getaffinity", 1, 0, 0,
return cpu_set_to_bitvector (&cs); return cpu_set_to_bitvector (&cs);
} }
#undef FUNC_NAME #undef FUNC_NAME
#endif /* HAVE_SCHED_GETAFFINITY */ #endif /* HAVE_SCHED_GETAFFINITY */
#ifdef HAVE_SCHED_SETAFFINITY #ifdef HAVE_SCHED_SETAFFINITY
SCM_DEFINE (scm_setaffinity, "setaffinity", 2, 0, 0, SCM_DEFINE (scm_setaffinity, "setaffinity", 2, 0, 0,
(SCM pid, SCM mask), (SCM pid, SCM mask),
"Install the CPU affinity mask @var{mask}, a bitvector, for\n" "Install the CPU affinity mask @var{mask}, a bitvector, for\n"
"the process or thread with ID @var{pid}. The return value\n" "the process or thread with ID @var{pid}. The return value\n"
"is unspecified.\n\n" "is unspecified.")
"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 #define FUNC_NAME s_scm_setaffinity
{ {
cpu_set_t cs; cpu_set_t cs;
@ -2040,7 +2031,6 @@ SCM_DEFINE (scm_setaffinity, "setaffinity", 2, 0, 0,
return SCM_UNSPECIFIED; return SCM_UNSPECIFIED;
} }
#undef FUNC_NAME #undef FUNC_NAME
#endif /* HAVE_SCHED_SETAFFINITY */ #endif /* HAVE_SCHED_SETAFFINITY */