Merge pull request Ericsson#3154 from csordasmarton/use_summary_in_md…

…_files

[doc] Using details/summary in md files to show help message

analyzer/tools/merge_clang_extdef_mappings/README.md

@@ -22,7 +22,12 @@ make package
 ```
 
 ## Usage
-```sh
+<details>
+  <summary>
+    <i>$ <b>merge-clang-extdef-mappings --help</b> (click to expand)</i>
+  </summary>
+
+```
 usage: merge-clang-extdef-mappings [-h] -i input -o output
 
 Merge individual clang extdef mapping files into one mapping file.
@@ -40,6 +45,7 @@ Example:
   merge-clang-extdef-mappings -i /path/to/fn_map_folder -o
   /path/to/externalDefMap.txt
 ```
+</details>
 
 ## License
 

analyzer/tools/statistics_collector/README.md

@@ -16,7 +16,12 @@ make package
 ```
 
 ## Usage
-```sh
+<details>
+  <summary>
+    <i>$ <b>post-process-stats --help</b> (click to expand)</i>
+  </summary>
+
+```
 usage: post-process-stats [-h] -i folder
                           [--stats-min-sample-count STATS_MIN_SAMPLE_COUNT]
                           [--stats-relevance-threshold STATS_RELEVANCE_THRESHOLD]
@@ -50,6 +55,7 @@ optional arguments:
 Example:
   post-process-stats -i /path/to/pre_processed_stats /path/to/stats
 ```
+</details>
 
 ## License
 

docs/analyzer/user_guide.md

@@ -86,6 +86,11 @@ _User guide_) for information about the arguments which are not documented
 here. For example the CTU related arguments are documented at `analyze`
 subcommand.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker check --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker check [-h] [-o OUTPUT_DIR] [-t {plist}] [-q]
                          [--keep-gcc-include-fixed] [--keep-gcc-intrin]
@@ -461,6 +466,7 @@ command actually builds the files -- it is advised to execute builds on empty
 trees, aka. after a 'make clean', as CodeChecker only analyzes files that had
 been used by the build system.
 ```
+</details>
 
 # Available CodeChecker analyzer subcommands <a name="available-analyzer-commands"></a>
 
@@ -471,6 +477,11 @@ information about the files in your project for the analyzers. This is done by
 recording a build of your project, which is done by the command `CodeChecker
 log`.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker log --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker log [-h] -o LOGFILE -b COMMAND [-q]
                        [--verbose {info,debug,debug_analyzer}]
@@ -531,6 +542,7 @@ Environment variables
                            a 'codechecker.logger.debug' file beside the log
                            file.
 ```
+</details>
 
 Please note, that only the files that are used in the given `--build` argument
 will be recorded. To analyze your whole project, make sure your build tree has
@@ -729,6 +741,11 @@ CodeChecker analyze ../codechecker_myProject_build.log -o my_plists
 `CodeChecker analyze` supports a myriad of fine-tuning arguments, explained
 below:
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker analyze --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker analyze [-h] [-j JOBS]
                            [-i SKIPFILE | --file FILE [FILE ...]] -o
@@ -856,6 +873,7 @@ Environment variables
   CC_SEVERITY_MAP_FILE     Path of the checker-severity mapping config file.
                            Default: <package>/config/checker_severity_map.json
 ```
+</details>
 
 
 ### _Skip_ file <a name="skip"></a>
@@ -1482,6 +1500,11 @@ Statistics analysis feature arguments:
 (such as `plist` files), usually previously generated by `CodeChecker analyze`.
 `parse` prints analysis results to the standard output.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker parse --help</b> (click to expand)</i>
+  </summary>
+
 ```
 Usage: CodeChecker parse [-h] [--config CONFIG_FILE] [-t {plist}]
                          [-e {html,json,codeclimate,gerrit}] [-o OUTPUT_PATH]
@@ -1570,6 +1593,7 @@ Environment variables
                       generating gerrit output.
                          Default: <package>/config/checker_severity_map.json
 ```
+</details>
 
 For example, if the analysis was run like:
 
@@ -1591,6 +1615,11 @@ For example there is a ClangTidy checker which suggests using
 simple changes can be applied directy in the source code. `CodeChecker fixit`
 command handles these automatic fixes.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker fixit --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker fixit [-h] [-l]
                          [--checker-name [CHECKER_NAME [CHECKER_NAME...]]]
@@ -1630,6 +1659,7 @@ optional arguments:
   --verbose {info,debug,debug_analyzer}
                         Set verbosity level.
 ```
+</details>
 
 ## `checkers`<a name="checkers"></a>
 
@@ -1639,6 +1669,11 @@ performing an analysis.
 By default, `CodeChecker checkers` will list all checkers, one per each row,
 providing a quick overview on which checkers are available in the analyzers.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker checkers --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker checkers [-h] [--analyzers ANALYZER [ANALYZER ...]]
                             [--details] [--profile {PROFILE/list}]
@@ -1691,6 +1726,7 @@ Environment variables
   CC_PROFILE_MAP_FILE    Path of the checker-profile mapping config file.
                          Default: '<package>/config/checker_profile_map.json'
 ```
+</details>
 
 The list provided by default is formatted for easy machine and human
 reading. Use the `--only-` options (`--only-enabled` and `--only-disabled`) to
@@ -1725,6 +1761,11 @@ information.
 By default, this command only lists the names of the available analyzers (with
 respect to the environment CodeChecker is run in).
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker analyzers --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker analyzers [-h] [--all] [--details]
                              [--dump-config {clang-tidy,clangsa}]
@@ -1759,6 +1800,7 @@ optional arguments:
   --verbose {info,debug_analyzer,debug}
                         Set verbosity level.
 ```
+</details>
 
 A detailed view of the available analyzers is available via `--details`. In the
 *detailed view*, version string and install path is also printed.

docs/web/authentication.md

@@ -342,6 +342,11 @@ by using the package's `config/session_client.json` as an example.
 > access this file. Executing `chmod 0600 ~/.codechecker.passwords.json` will
 > limit access to your user only.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd login --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker cmd login [-h] [-d] [--url SERVER_URL]
                              [--verbose {info,debug,debug_analyzer}]
@@ -365,6 +370,7 @@ common arguments:
   --verbose {info,debug,debug_analyzer}
                         Set verbosity level.
 ```
+</details>
 
 The user can log in onto the server by issuing the command `CodeChecker cmd
 login <username>`. After receiving an *Authentication successful!* message,
@@ -457,6 +463,11 @@ Personal tokens can be written instead of the user's password in the
 ```
 
 ## New personal access token <a name="new-personal-access-token"></a>
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd token new --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker cmd token new [-h] [--description DESCRIPTION]
                                  [--url SERVER_URL]
@@ -470,8 +481,13 @@ optional arguments:
                         A custom textual description to be shown alongside the
                         token.
 ```
+</details>
 
 ## List personal access tokens <a name="list-personal-access-token"></a>
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd token list --help</b> (click to expand)</i>
+  </summary>
 
 ```
 usage: CodeChecker cmd token list [-h] [--url SERVER_URL]
@@ -484,8 +500,14 @@ List the available personal access tokens.
 optional arguments:
   -h, --help            show this help message and exit
 ```
+</details>
 
 ## Remove personal access token <a name="remove-personal-access-token"></a>
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd token del --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker cmd token del [-h] [--url SERVER_URL]
                                  [--verbose {info,debug,debug_analyzer}]
@@ -496,3 +518,4 @@ Removes the specified access token.
 positional arguments:
   TOKEN                 Personal access token which will be deleted.
 ```
+</details>

docs/web/products.md

@@ -110,6 +110,11 @@ common arguments:
 `add` assigns the unique `PRODUCT_NAME` endpoint with a database connection,
 making a new product available on the server.
 
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd products add --help</b> (click to expand)</i>
+  </summary>
+
 ```
 usage: CodeChecker cmd products add [-h] [-n DISPLAY_NAME]
                                     [--description DESCRIPTION]
@@ -166,8 +171,13 @@ PostgreSQL arguments:
   --dbname DBNAME, --db-name DBNAME
                         Name of the database to use. (default: <ENDPOINT>)
 ```
+</details>
 
 ## Delete a product (`del`) <a name="delete-a-product"></a>
+<details>
+  <summary>
+    <i>$ <b>CodeChecker cmd token new --help</b> (click to expand)</i>
+  </summary>
 
 ```
 usage: CodeChecker cmd products del [-h] [--url SERVER_URL]
@@ -186,6 +196,7 @@ positional arguments:
 optional arguments:
   -h, --help            show this help message and exit
 ```
+</details>
 
 # Managing products through the web interface <a name="web-interface"></a>