Merge branch 'topic/148' into 'master'

Automatic generation of pre-defined checks documentation

Closes #148 and #150

See merge request eng/libadalang/langkit-query-language!311

Makefile

@@ -34,6 +34,7 @@ lkql: build/bin/liblkqllang_parse
 
 doc: build_lkql_native_jit
 	cd user_manual && make clean html
+	cd lkql_checker/doc && make generate html-all
 
 gnatcheck: lkql
 	gprbuild -P lkql_checker/gnatcheck.gpr -p $(GPR_ARGS) -XBUILD_MODE=$(BUILD_MODE)

lkql_checker/doc/Makefile

@@ -42,6 +42,9 @@ help:
 clean:
 	-rm -rf $(BUILDDIR)
 
+generate:
+	lkql doc-rules -O generated $(SOURCEDIR)/../share/lkql $(SOURCEDIR)/stubs
+
 %.html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/$*/html
 

lkql_checker/doc/gnatcheck_rm/list_of_rules.rst → lkql_checker/doc/generated/list_of_rules.rst

@@ -55,8 +55,8 @@ GNATcheck rules.
 * :ref:`Exception_Propagation_From_Export`
 * :ref:`Exception_Propagation_From_Tasks`
 * :ref:`Exceptions_As_Control_Flow`
-* :ref:`Exits_From_Conditional_Loops`
 * :ref:`EXIT_Statements_With_No_Loop_Name`
+* :ref:`Exits_From_Conditional_Loops`
 * :ref:`Expanded_Loop_Exit_Names`
 * :ref:`Explicit_Full_Discrete_Ranges`
 * :ref:`Explicit_Inlining`
@@ -112,12 +112,12 @@ GNATcheck rules.
 * :ref:`Non_Component_In_Barriers`
 * :ref:`Non_Constant_Overlays`
 * :ref:`Non_Qualified_Aggregates`
-* :ref:`Nonoverlay_Address_Specifications`
 * :ref:`Non_Short_Circuit_Operators`
 * :ref:`Non_SPARK_Attributes`
 * :ref:`Non_Tagged_Derived_Types`
-* :ref:`Not_Imported_Overlays`
 * :ref:`Non_Visible_Exceptions`
+* :ref:`Nonoverlay_Address_Specifications`
+* :ref:`Not_Imported_Overlays`
 * :ref:`Null_Paths`
 * :ref:`Number_Declarations`
 * :ref:`Numeric_Format`