Merge branch 'topic/fix_settings' into 'master'

Synchronize seddings documentsion with `package.json`

See merge request eng/ide/ada_language_server!1185

Author: reznikmm

doc/settings.md

@@ -210,3 +210,8 @@ For more information about documentation styles see GNATdoc User's Manual.
 ```javascript
     'documentationStyle': 'gnat'
 ```
+
+## trace.server
+
+This option controls the tracing of the communication between VSCode and the Ada language server.
+The separate setting `gpr.trace.server` controls tracing for GPR language server.

integration/vscode/ada/package.json

@@ -312,6 +312,20 @@
                         "default": "iso-8859-1",
                         "description": "The character set to use while reading files from disk."
                     },
+                    "ada.documentationStyle": {
+                        "scope": "resource",
+                        "type": "string",
+                        "enum": [
+                            "gnat",
+                            "leading"
+                        ],
+                        "enumDescriptions": [
+                            "Default style, based on GNAT coding standard with some enhancements.",
+                            "Documentation for the entities extracted from the comments before the entity declaration."
+                        ],
+                        "default": "gnat",
+                        "description": "Controls primary documentation style of entities."
+                    },
                     "ada.displayMethodAncestryOnNavigation": {
                         "scope": "resource",
                         "type": "string",
@@ -336,6 +350,42 @@
                         "default": true,
                         "description": "The emission of diagnostics."
                     },
+                    "ada.enableIndexing": {
+                        "scope": "resource",
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Controls indexing the source files after loading a project."
+                    },
+                    "ada.foldComments": {
+                        "scope": "resource",
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Controls the inclusion of comments in folding blocks."
+                    },
+                    "ada.followSymlinks": {
+                        "scope": "resource",
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Controls the file names normalization sent by a client."
+                    },
+                    "ada.namedNotationThreshold": {
+                        "scope": "resource",
+                        "type": "integer",
+                        "default": 3,
+                        "description": "Defines the number of parameters/components at which point named notation is used for completion snippets."
+                    },
+                    "ada.relocateBuildTree": {
+                        "scope": "resource",
+                        "type": "string",
+                        "default": "",
+                        "description": "The folder for out-of-tree build."
+                    },
+                    "ada.rootDir": {
+                        "scope": "resource",
+                        "type": "string",
+                        "default": "",
+                        "description": "The root directory for artifacts for proper relocation. Used with relocateBuildTree."
+                    },
                     "ada.useCompletionSnippets": {
                         "scope": "resource",
                         "type": "boolean",

testsuite/drivers/shell.py

@@ -0,0 +1,25 @@
+import os.path
+
+from e3.testsuite.result import TestStatus
+
+from drivers import ALSTestDriver
+
+
+class ShellTestDriver(ALSTestDriver):
+    """
+    Run the test.sh test program.
+
+    """
+
+    def run(self, previous_values, slot):
+        # Check whether the test should be skipped
+        if self.should_skip():
+            return False
+
+        index = os.path.abspath(os.path.join(self.test_env["test_dir"], "index.txt"))
+        test_sh = os.path.join(self.env.repo_base, 'testsuite', 'shell', 'test.sh')
+        p = self.run_and_log([test_sh, self.env.repo_base], cwd=self.env.working_dir)
+        self.result.out += p.out
+
+        self.result.set_status(TestStatus.PASS if p.status == 0 else TestStatus.FAIL)
+        self.push_result()

testsuite/shell/test.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+jq -r '.contributes.configuration[].properties|keys[]' < $1/integration/vscode/ada/package.json | grep ^ada. > pkg.txt
+grep '^## ' $1/doc/settings.md |sed -e 's/.../ada./' | sort > doc.txt
+diff -u pkg.txt doc.txt

testsuite/shell/test.yaml

@@ -0,0 +1,5 @@
+driver: shell
+title: 'settings_docs'
+# Test only on Linux, since it depends on `bash`, `jq` and `diff`
+skip:
+    - ['SKIP', 'env.build.os.name != "linux"']

testsuite/testsuite.py

@@ -6,9 +6,11 @@
 
 from distutils.spawn import find_executable
 from e3.testsuite import Testsuite
+from e3.testsuite.driver.diff import DiffTestDriver
 
 from drivers.basic import JsonTestDriver
 from drivers.codecs import CodecsTestDriver
+from drivers.shell import ShellTestDriver
 from drivers.gnatcov import GNATcov
 
 VALGRIND_OPTIONS = [
@@ -99,7 +101,8 @@ def tear_down(self):
     @property
     def test_driver_map(self):
         return {'ada_lsp': JsonTestDriver,
-                'codecs': CodecsTestDriver}
+                'codecs': CodecsTestDriver,
+                'shell': ShellTestDriver}
 
     @property
     def default_driver(self):