num_emerge_threads: Warn of crashes when > 1 (#8357)

This commit is contained in:
Paramat 2019-03-14 12:49:33 +00:00 committed by rubenwardy
parent dd451a8a00
commit 10cc62d2ca
2 changed files with 10 additions and 6 deletions

@ -1915,16 +1915,18 @@ emergequeue_limit_diskonly (Limit of emerge queues on disk) int 64
emergequeue_limit_generate (Limit of emerge queues to generate) int 64 emergequeue_limit_generate (Limit of emerge queues to generate) int 64
# Number of emerge threads to use. # Number of emerge threads to use.
# WARNING: Currently there are multiple bugs that may cause crashes when
# 'num_emerge_threads' is larger than 1. Until this warning is removed it is
# strongly recommended this value is set to the default '1'.
# Empty or 0 value: # Empty or 0 value:
# - Automatic selection. The number of emerge threads will be # - Automatic selection. The number of emerge threads will be
# - 'number of processors - 2', with a lower limit of 1. # - 'number of processors - 2', with a lower limit of 1.
# Any other value: # Any other value:
# - Specifies the number of emerge threads, with a lower limit of 1. # - Specifies the number of emerge threads, with a lower limit of 1.
# Warning: Increasing the number of emerge threads increases engine mapgen # WARNING: Increasing the number of emerge threads increases engine mapgen
# speed, but this may harm game performance by interfering with other # speed, but this may harm game performance by interfering with other
# processes, especially in singleplayer and/or when running Lua code in # processes, especially in singleplayer and/or when running Lua code in
# 'on_generated'. # 'on_generated'. For many users the optimum setting may be '1'.
# For many users the optimum setting may be '1'.
num_emerge_threads (Number of emerge threads) int 1 num_emerge_threads (Number of emerge threads) int 1
[Online Content Repository] [Online Content Repository]

@ -2994,16 +2994,18 @@
# emergequeue_limit_generate = 64 # emergequeue_limit_generate = 64
# Number of emerge threads to use. # Number of emerge threads to use.
# WARNING: Currently there are multiple bugs that may cause crashes when
# 'num_emerge_threads' is larger than 1. Until this warning is removed it is
# strongly recommended this value is set to the default '1'.
# Empty or 0 value: # Empty or 0 value:
# - Automatic selection. The number of emerge threads will be # - Automatic selection. The number of emerge threads will be
# - 'number of processors - 2', with a lower limit of 1. # - 'number of processors - 2', with a lower limit of 1.
# Any other value: # Any other value:
# - Specifies the number of emerge threads, with a lower limit of 1. # - Specifies the number of emerge threads, with a lower limit of 1.
# Warning: Increasing the number of emerge threads increases engine mapgen # WARNING: Increasing the number of emerge threads increases engine mapgen
# speed, but this may harm game performance by interfering with other # speed, but this may harm game performance by interfering with other
# processes, especially in singleplayer and/or when running Lua code in # processes, especially in singleplayer and/or when running Lua code in
# 'on_generated'. # 'on_generated'. For many users the optimum setting may be '1'.
# For many users the optimum setting may be '1'.
# type: int # type: int
# num_emerge_threads = 1 # num_emerge_threads = 1