Skip to content

Commit 930b17a

Browse files
committed
clarify compileForOverlayEval only needed in language packs
1 parent efe413c commit 930b17a

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/codeql/ql-language-reference/annotations.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -530,10 +530,11 @@ support is enabled for a language.
530530

531531
.. note::
532532

533-
Overlay annotations only affect evaluation when overlay compilation is enabled for a
534-
QL pack (via ``compileForOverlayEval: true`` in ``qlpack.yml``) and the evaluator is
535-
running in overlay mode. Otherwise, these annotations are validated but have no effect
536-
on evaluation.
533+
Overlay annotations only affect evaluation when overlay compilation is enabled
534+
(via ``compileForOverlayEval: true`` in ``qlpack.yml``) and the evaluator is running
535+
in overlay mode. This setting is typically only needed in the language's library pack;
536+
custom query packs do not need it. Outside of overlay mode, these annotations are
537+
validated but have no effect on evaluation.
537538

538539
``overlay[local]``
539540
------------------

0 commit comments

Comments
 (0)