summaryrefslogtreecommitdiff
path: root/include/gc.h
diff options
context:
space:
mode:
authorIvan Maidanski <ivmai@mail.ru>2019-04-03 11:09:37 +0300
committerIvan Maidanski <ivmai@mail.ru>2019-04-03 11:09:37 +0300
commitc755adda14ec940c995e52a2304d2c0383fb05fe (patch)
treef064bca66fd8d0daebd6cf3712be6e8cc7cfbf10 /include/gc.h
parent4e51d173e9d2eb0c3d94a546aff9c5631923f19f (diff)
downloadbdwgc-c755adda14ec940c995e52a2304d2c0383fb05fe.tar.gz
Refine GC_parallel documentation in gc.h
* include/gc.h [GC_THREADS] (GC_parallel): Refine comment about the case when it is non-zero.
Diffstat (limited to 'include/gc.h')
-rw-r--r--include/gc.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/include/gc.h b/include/gc.h
index c7d84e3a..0778ad91 100644
--- a/include/gc.h
+++ b/include/gc.h
@@ -89,11 +89,12 @@ GC_API GC_word GC_CALL GC_get_gc_no(void);
#ifdef GC_THREADS
GC_API GC_ATTR_DEPRECATED int GC_parallel;
/* GC is parallelized for performance on */
- /* multiprocessors. Currently set only */
- /* implicitly if collector is built with */
- /* PARALLEL_MARK defined and if either: */
- /* Env variable GC_NPROCS is set to > 1, or */
- /* GC_NPROCS is not set and this is an MP. */
+ /* multiprocessors. Set to a non-zero value */
+ /* only implicitly if collector is built with */
+ /* PARALLEL_MARK defined, and if either */
+ /* GC_MARKERS (or GC_NPROCS) environment */
+ /* variable is set to > 1, or multiple cores */
+ /* (processors) are available. */
/* If GC_parallel is on (non-zero), incremental */
/* collection is only partially functional, */
/* and may not be desirable. The getter does */