Skip to content

Commit af6f4b8

Browse files
committed
Merge branch 'topic/rules_in_doc' into 'master'
Update GNATcheck RM sources to stick to the generated doc See merge request eng/libadalang/langkit-query-language!336
2 parents 87103b6 + 8c4dc7f commit af6f4b8

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

lkql_checker/share/lkql/silent_exception_handlers.lkql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ fun silent_exception_handlers(node, subprograms=[], subprogram_regexps=[]) =
3636
|"
3737
|" Note that if you specify the rule with parameters in a command shell, you may
3838
|" need to escape its parameters. The best and the safest way of using this rule
39-
|" is to place it into a rule file and to use this rule file as a parameter of the
40-
|" ``-from=`` option, no escaping is needed in this case.
39+
|" is to place it into an LKQL rule file and to use this rule file with the
40+
|" ``--rule-file`` switch, no escaping is needed in this case.
4141
|"
4242
|" .. rubric:: Example
4343
|"

lkql_jit/cli/src/main/java/com/adacore/lkql_jit/LKQLDocRules.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,8 +335,9 @@ public Integer call() throws Exception {
335335
336336
The description of the rules currently implemented in ``gnatcheck`` is
337337
given in this chapter.
338-
The rule identifier is used as a parameter of ``gnatcheck``'s ``+R`` or ``-R``
339-
switches.
338+
The rule identifier is used as a key for LKQL rule configuration objects (see
339+
:ref:`LKQL rule file<LKQL_options_file>`), and as first parameter of
340+
``gnatcheck``'s ``+R`` or ``-R`` switches.
340341
341342
Be aware that most of these rules apply to specialized coding
342343
requirements developed by individual users and may well not make sense in

0 commit comments

Comments
 (0)