Merge branch '272-thread-pool-docs' into 'master'

gthreadpool: Mention g_get_num_processors() in the thread pool docs

Closes #272

See merge request GNOME/glib!1588
This commit is contained in:
Sebastian Dröge 2020-07-27 19:04:11 +00:00
commit 9577616622

View File

@ -528,6 +528,10 @@ g_thread_pool_start_thread (GRealThreadPool *pool,
* with the two arguments. The first one is the parameter to
* g_thread_pool_push() and the second one is @user_data.
*
* Pass g_get_num_processors() to @max_threads to create as many threads as
* there are logical processors on the system. This will not pin each thread to
* a specific processor.
*
* The parameter @exclusive determines whether the thread pool owns
* all threads exclusive or shares them with other thread pools.
* If @exclusive is %TRUE, @max_threads threads are started