From 02016c0ef25f6a521aae789727487e0bbc71014a Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 3 Apr 2021 23:18:06 +0900 Subject: [PATCH] Close #8829: doc: Update description of paralle-read-safe --- doc/extdev/index.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index ad04951f3..d9c04f413 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -171,10 +171,26 @@ as metadata of the extension. Metadata keys currently recognized are: source files can be used when the extension is loaded. It defaults to ``False``, i.e. you have to explicitly specify your extension to be parallel-read-safe after checking that it is. + + .. note:: The *parallel-read-safe* extension must satisfy the following + conditions: + + * The core logic of the extension is parallely executable during + the reading phase. + * It has event handlers for :event:`env-merge-info` and + :event:`env-purge-doc` events if it stores dataa to the build + environment object (env) during the reading phase. + * ``'parallel_write_safe'``: a boolean that specifies if parallel writing of output files can be used when the extension is loaded. Since extensions usually don't negatively influence the process, this defaults to ``True``. + .. note:: The *parallel-write-safe* extension must satisfy the following + conditions: + + * The core logic of the extension is parallely executable during + the writing phase. + APIs used for writing extensions --------------------------------