Skip to content

Commit 67b3595

Browse files
committed
Making it clear that it may disappear.
1 parent 6c33f51 commit 67b3595

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

cmake/simdjson-flags.cmake

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,12 @@ if(SIMDJSON_ENABLE_THREADS)
117117
endif()
118118

119119
# Some users compile simdjson with thread support but still do not want simdjson to use threads.
120-
option(SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT "Whether we enabled thread support or not (SIMDJSON_ENABLE_THREADS), do not use threads. This option does nothing when thread support is not enabled." OFF)
120+
#
121+
# Important : Expect this option to disappear in the future.
122+
#
123+
option(SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT "Whether we enabled thread support or not (SIMDJSON_ENABLE_THREADS), do not use threads.\
124+
This option does nothing when thread support is not enabled. We reserve the right to remove this option in a future release in\
125+
favor of a runtime approach." OFF)
121126
if(SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT)
122127
target_compile_definitions(simdjson-flags INTERFACE SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT=1)
123128
endif()

doc/parse_many.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,6 @@ A `document_stream` instance uses at most two threads: there is a main thread an
101101
You should expect the main thread to be fully occupied while the worker thread is partially busy
102102
(e.g., 80% of the time).
103103

104-
If you compile simdjson with thread support and you still do not want simdjson to use threads,
105-
you can forcefully disable them by setting the SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT macro
106-
to 1 in C++, or by passing SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT=ON to cmake. It is a
107-
compile-time decision: if you disable the threads with SIMDJSON_DO_NOT_USE_THREADS_NO_MATTER_WHAT,
108-
you will not be able to use threads in simdjson unless you recompile.
109-
110104
Support
111105
-------
112106

0 commit comments

Comments
 (0)