From 3fede9e2d990a0ee71b6c2b0686e75dd5f36eb7d Mon Sep 17 00:00:00 2001 From: JasperCraeghs <28319872+JasperCraeghs@users.noreply.github.com> Date: Mon, 21 Oct 2024 15:42:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20melexis/?= =?UTF-8?q?warnings-plugin@11b779997c15bc736cf302fd3090287471b06e9c=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _modules/index.html | 6 +- _modules/mlx/warnings/exceptions.html | 6 +- _modules/mlx/warnings/junit_checker.html | 6 +- _modules/mlx/warnings/polyspace_checker.html | 16 ++- _modules/mlx/warnings/regex_checker.html | 16 ++- _modules/mlx/warnings/robot_checker.html | 8 +- _modules/mlx/warnings/warnings.html | 9 +- _modules/mlx/warnings/warnings_checker.html | 15 ++- _static/documentation_options.js | 2 +- authors.html | 6 +- contributing.html | 6 +- design.html | 55 ++++++++-- genindex.html | 18 +++- index.html | 6 +- installation.html | 6 +- objects.inv | Bin 1144 -> 1159 bytes output.json | 36 +++---- output.txt | 8 +- py-modindex.html | 6 +- readme.html | 106 ++++++++++--------- search.html | 6 +- searchindex.js | 2 +- 22 files changed, 204 insertions(+), 141 deletions(-) diff --git a/_modules/index.html b/_modules/index.html index 8c0c5341..08a6d773 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -4,7 +4,7 @@ - Overview: module code — warning-plugin 5.5.0 documentation + Overview: module code — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -111,7 +111,7 @@

Navigation

diff --git a/_modules/mlx/warnings/exceptions.html b/_modules/mlx/warnings/exceptions.html index 5752b198..691efc59 100644 --- a/_modules/mlx/warnings/exceptions.html +++ b/_modules/mlx/warnings/exceptions.html @@ -4,7 +4,7 @@ - mlx.warnings.exceptions — warning-plugin 5.5.0 documentation + mlx.warnings.exceptions — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -107,7 +107,7 @@

Navigation

diff --git a/_modules/mlx/warnings/junit_checker.html b/_modules/mlx/warnings/junit_checker.html index 9f3a7033..ebf1ef49 100644 --- a/_modules/mlx/warnings/junit_checker.html +++ b/_modules/mlx/warnings/junit_checker.html @@ -4,7 +4,7 @@ - mlx.warnings.junit_checker — warning-plugin 5.5.0 documentation + mlx.warnings.junit_checker — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -173,7 +173,7 @@

Navigation

diff --git a/_modules/mlx/warnings/polyspace_checker.html b/_modules/mlx/warnings/polyspace_checker.html index 18bb6f07..e01738c4 100644 --- a/_modules/mlx/warnings/polyspace_checker.html +++ b/_modules/mlx/warnings/polyspace_checker.html @@ -4,7 +4,7 @@ - mlx.warnings.polyspace_checker — warning-plugin 5.5.0 documentation + mlx.warnings.polyspace_checker — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -67,9 +67,16 @@

Source code for mlx.warnings.polyspace_checker

super().__init__(verbose) self._cq_description_template = Template('Polyspace: $check') + @property + def cq_findings(self): + ''' List[dict]: list of code quality findings''' + for checker in self.checkers: + self._cq_findings.extend(checker.cq_findings) + return self._cq_findings + @property def counted_warnings(self): - ''' List: list of counted warnings (str) ''' + '''List[str]: list of counted warnings''' all_counted_warnings = [] for checker in self.checkers: all_counted_warnings.extend(checker.counted_warnings) @@ -196,7 +203,6 @@

Source code for mlx.warnings.polyspace_checker

check_value = value.lower() checker = PolyspaceFamilyChecker(family_value, column_name, check_value, verbose=self.verbose) checker.parse_config(check) - checker.cq_findings = self.cq_findings # share object with sub-checkers self.checkers.append(checker) if not (column_name and check_value): raise ValueError( @@ -377,7 +383,7 @@

Navigation

diff --git a/_modules/mlx/warnings/regex_checker.html b/_modules/mlx/warnings/regex_checker.html index 21958fbd..87094938 100644 --- a/_modules/mlx/warnings/regex_checker.html +++ b/_modules/mlx/warnings/regex_checker.html @@ -4,7 +4,7 @@ - mlx.warnings.regex_checker — warning-plugin 5.5.0 documentation + mlx.warnings.regex_checker — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -161,12 +161,19 @@

Source code for mlx.warnings.regex_checker

 
     @property
     def counted_warnings(self):
-        ''' List: list of counted warnings (str) '''
+        ''' List[str]: list of counted warnings'''
         all_counted_warnings = []
         for checker in self.checkers.values():
             all_counted_warnings.extend(checker.counted_warnings)
         return all_counted_warnings
 
+    @property
+    def cq_findings(self):
+        ''' List[dict]: list of code quality findings'''
+        for checker in self.checkers.values():
+            self._cq_findings.extend(checker.cq_findings)
+        return self._cq_findings
+
     @property
     def cq_description_template(self):
         ''' Template: string.Template instance based on the configured template string '''
@@ -243,7 +250,6 @@ 

Source code for mlx.warnings.regex_checker

                     checker.maximum = int(maximum)
                 if minimum := checker_config.get("min", 0):
                     checker.minimum = int(minimum)
-                checker.cq_findings = self.cq_findings  # share object with sub-checkers
                 self.checkers[classification_key] = checker
             else:
                 print(f"WARNING: Unrecognized classification {classification!r}")
@@ -432,7 +438,7 @@ 

Navigation

diff --git a/_modules/mlx/warnings/robot_checker.html b/_modules/mlx/warnings/robot_checker.html index 12233d34..17207000 100644 --- a/_modules/mlx/warnings/robot_checker.html +++ b/_modules/mlx/warnings/robot_checker.html @@ -4,7 +4,7 @@ - mlx.warnings.robot_checker — warning-plugin 5.5.0 documentation + mlx.warnings.robot_checker — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -62,7 +62,7 @@

Source code for mlx.warnings.robot_checker

 
     @property
     def counted_warnings(self):
-        ''' List: list of counted warnings (str) '''
+        '''List[str]: list of counted warnings'''
         all_counted_warnings = []
         for checker in self.checkers:
             all_counted_warnings.extend(checker.counted_warnings)
@@ -262,7 +262,7 @@ 

Navigation

diff --git a/_modules/mlx/warnings/warnings.html b/_modules/mlx/warnings/warnings.html index f1499469..6c7bbdb4 100644 --- a/_modules/mlx/warnings/warnings.html +++ b/_modules/mlx/warnings/warnings.html @@ -4,7 +4,7 @@ - mlx.warnings.warnings — warning-plugin 5.5.0 documentation + mlx.warnings.warnings — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -269,6 +269,7 @@

Source code for mlx.warnings.warnings

         Args:
             out_file (str): Location for the output file
         '''
+        Path(out_file).parent.mkdir(parents=True, exist_ok=True)
         with open(out_file, 'w', encoding='utf-8', newline='\n') as open_file:
             for checker in self.activated_checkers.values():
                 open_file.write("\n".join(checker.counted_warnings) + "\n")
@@ -283,6 +284,8 @@

Source code for mlx.warnings.warnings

         for checker in self.activated_checkers.values():
             results.extend(checker.cq_findings)
         content = json.dumps(results, indent=4, sort_keys=False)
+
+        Path(out_file).parent.mkdir(parents=True, exist_ok=True)
         with open(out_file, 'w', encoding='utf-8', newline='\n') as open_file:
             open_file.write(f"{content}\n")
@@ -525,7 +528,7 @@

Navigation

diff --git a/_modules/mlx/warnings/warnings_checker.html b/_modules/mlx/warnings/warnings_checker.html index 0e21089b..602fc23d 100644 --- a/_modules/mlx/warnings/warnings_checker.html +++ b/_modules/mlx/warnings/warnings_checker.html @@ -4,7 +4,7 @@ - mlx.warnings.warnings_checker — warning-plugin 5.5.0 documentation + mlx.warnings.warnings_checker — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -92,16 +92,21 @@

Source code for mlx.warnings.warnings_checker

self._minimum = 0 self._maximum = 0 self._counted_warnings = [] - self.cq_findings = [] + self._cq_findings = [] self.cq_enabled = False self.cq_default_path = '.gitlab-ci.yml' self._cq_description_template = Template('$description') self.exclude_patterns = [] self.include_patterns = [] + @property + def cq_findings(self): + ''' List[dict]: list of code quality findings''' + return self._cq_findings + @property def counted_warnings(self): - ''' List: list of counted warnings (str) ''' + ''' List[str]: list of counted warnings''' return self._counted_warnings @property @@ -320,7 +325,7 @@

Navigation

diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 2bad5159..a6825636 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '5.5.0', + VERSION: '5.5.1', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/authors.html b/authors.html index 7995242b..4275745c 100644 --- a/authors.html +++ b/authors.html @@ -5,7 +5,7 @@ - Authors — warning-plugin 5.5.0 documentation + Authors — warning-plugin 5.5.1 documentation @@ -32,7 +32,7 @@

Navigation

@@ -125,7 +125,7 @@

Navigation

diff --git a/contributing.html b/contributing.html index 03c7bd3c..58adf58b 100644 --- a/contributing.html +++ b/contributing.html @@ -5,7 +5,7 @@ - Contribution Guide — warning-plugin 5.5.0 documentation + Contribution Guide — warning-plugin 5.5.1 documentation @@ -33,7 +33,7 @@

Navigation

@@ -170,7 +170,7 @@

Navigation

diff --git a/design.html b/design.html index 2f48006d..5b157fe1 100644 --- a/design.html +++ b/design.html @@ -5,7 +5,7 @@ - Software Design — warning-plugin 5.5.0 documentation + Software Design — warning-plugin 5.5.1 documentation @@ -33,7 +33,7 @@

Navigation

@@ -238,10 +238,10 @@

String Handling
property counted_warnings
-

list of counted warnings (str)

+

list of counted warnings

Type:
-

List

+

List[str]

@@ -257,6 +257,17 @@

String Handling +
+property cq_findings
+

list of code quality findings

+
+
Type:
+

List[dict]

+
+
+
+
name = 'coverity'
@@ -382,10 +393,10 @@

String Handling
property counted_warnings
-

list of counted warnings (str)

+

list of counted warnings

Type:
-

List

+

List[str]

@@ -401,6 +412,17 @@

String Handling +
+property cq_findings
+

list of code quality findings

+
+
Type:
+

List[dict]

+
+
+
+
property maximum
@@ -559,10 +581,10 @@

String Handling
property counted_warnings
-

list of counted warnings (str)

+

list of counted warnings

Type:
-

List

+

List[str]

@@ -724,10 +746,10 @@

String Handling
property counted_warnings
-

list of counted warnings (str)

+

list of counted warnings

Type:
-

List

+

List[str]

@@ -743,6 +765,17 @@

String Handling +
+property cq_findings
+

list of code quality findings

+
+
Type:
+

List[dict]

+
+
+
+
property maximum
@@ -1092,7 +1125,7 @@

Navigation

diff --git a/genindex.html b/genindex.html index 7812fe3a..2ce4fc97 100644 --- a/genindex.html +++ b/genindex.html @@ -4,7 +4,7 @@ - Index — warning-plugin 5.5.0 documentation + Index — warning-plugin 5.5.1 documentation @@ -30,7 +30,7 @@

Navigation

@@ -113,10 +113,10 @@

C

  • code_quality_severity (mlx.warnings.PolyspaceFamilyChecker attribute)
  • - - + +
  • cq_findings (mlx.warnings.CoverityChecker property) + +
  • @@ -423,7 +431,7 @@

    Navigation

    diff --git a/index.html b/index.html index 93d5b246..28cb038a 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ - Contents — warning-plugin 5.5.0 documentation + Contents — warning-plugin 5.5.1 documentation @@ -32,7 +32,7 @@

    Navigation

    @@ -159,7 +159,7 @@

    Navigation

    diff --git a/installation.html b/installation.html index b0dd1094..54c048fe 100644 --- a/installation.html +++ b/installation.html @@ -5,7 +5,7 @@ - Installation Guide — warning-plugin 5.5.0 documentation + Installation Guide — warning-plugin 5.5.1 documentation @@ -33,7 +33,7 @@

    Navigation

    @@ -135,7 +135,7 @@

    Navigation

    diff --git a/objects.inv b/objects.inv index c05d5615ab2ef247c55f58eb73b1bb370615563d..65d3ff0e24c7f5710ab9b65461ebbd2cdd87149c 100644 GIT binary patch delta 1048 zcmV+z1n2ws2!{!fMgcLAM?8N`kJ~B~hWGgumTtF+Znxc4Gq+W%RvL9wwL8SvCk`zJ z7jP%}_ZNem0sIjI?P@ZF_c;eRycnmU=fg7=jIdf3?d46wtBykPZ&86HH9MSCL;taj z`&Y$&*EszTclt zxnA>F?eq*a77q@ZajR*;E25?1AA#&BcOz)A`7)ajfe0WB61P|4Ym)ajGm>i8g7 zRwe>eCm1rzjwoq}lIaPJu)YYkQ||dWx@;Xy{A#%3lsWwPl@S%2u`7z*Wu7*AxSqNd zpoua?5IOw?8xW!AY{}GOeq;QHHGE-)EqO#s3x2SpGng-c?`m` z8PP>MA*5O61e4`=i?leyyJFtqhR{p$p7P`eTva-e3ec|(Q*Fv)0p;eEyk!H5o0VqfZA{6g%NlZLB}~gbZ)=KndRC>*IfY$J0l9j;BuZ8xN7? zHM69IN_^~yf~0bEl}R<}0n&!>*q#VG$ENS84uqAo)8->ht2PV$3{>LYEE4mGuPk4l z^33TIrb9sjYB>J|Bq9toSe2(J_P60f?8*f?bEpl|6|r|hN@Vd)m;CvZs?sHK^?M{v$gmV5M!K0it+aQ$WTgc$a_9dDfR8@NaDbS}yX5(-UhO z?)&FYUpmG>#Gc%tFy6^0gp}u`tEFu)y}i%6>6k&N9~~pt+Fp1mxE8`w1nhRakzV=B zui(~VOjO(BEWDi96wTKLG3{gJ7;o{1i?u+ZXf?v@`{gydD_A8j+)mcmzGRiYycO31 zOjKcv{$_u6jWPeSVvX-9ZnNjFpEm<|vLMRMr;;uEdeAJOuVYxe$87SB_59JZz-?=x z$BvZ?4`R5}zAa=SRrRLgWgmHHGJT4-_Me@}3snTy0ym~N#ZN%POij1_*zL{?=HC9d z)2F_*+5WYm6VGk8LGP|DI_LKtsbFV=xH2bf@yLIVN)H^0d(*h9LC-;@Z>(OTW2@DC z=s)gWx(!&TN1p~TC3PpMFs1fZ@AZ9YAE8c9n|Z^lnOxe-e*D5JKil79ZC1{=H)IbN zy*|uW3&52=9i2pN%Q&j0!K^Ai5eCIrOogr3odhiOW!#Ht+lGm@-#_3Qc5;|>40Z}Qb_{H%CWQa*J>c;-xD7q-p0Qwr)v{<$?;2ip6pA-R1(MWkcTf#|WgEAz zi|wXy`tNS|9}q;HZVpiX2GQ$Filr>xdh%>hZ zaL4IMwz!1YQHR3Vkzaq-gOE`(Fr{Sp%M_MxFcW5jkEH3EJO*LejOb#U5Ynt}g30o! zSz4S?oiQJAL+B}aFL?4Dt}2~K1?Z{6RGTT<6IN+KZeGb-EugrmNw9{WRuTdDA8s3; zoVL36{Ev$nu(tq=ZU*=!k-( za&(nRHR%D;hValH2s_56@2Pf#m9*35BTcI|3w?Geac>rhdBj(iFHbou`h@9FkboMF z{{e{zLk(8tA&UKD_z=5tfzCYChUtpfJ0T^qcqj47##U9q#A1ulF5eAYvc6p)lUb zCxny(&e_sdnBLZBU3JVL)US?_b8XMOgU#{(0#|snS&Vav~LSpNL9V7 zc-coDnoOVKz5TK=d7+BnTHwa?ruY$Pn5pTu9lPC_!Q9$!8~xO`Hrv1NbK<$}Ht5Z{ zMd$pfBNc3H5Lf1eEgtw@>48IWYZ^B-=sBqLRnvS+bZoVn&;7^EOSb{*^yt$7rljs9 z6{gf)$GyHU?IYCbX)|wlbs?Abv>ku2%5U~Rmo_Ws*DJESlU^U@s|DanKOLP!ZOb^S zropT#z7ht-SWJbj*o_1%^ex(pY1@X0w!h!u8a8s6bmXkf#iAHHZikNHYW)Qw8Q!7j CuMO=0 diff --git a/output.json b/output.json index 5978c098..3a19b4ed 100644 --- a/output.json +++ b/output.json @@ -1,33 +1,33 @@ {"filename": "index.rst", "lineno": 17, "status": "unchecked", "code": 0, "uri": "", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 301, "uri": "http://www.apache.org/licenses/LICENSE-2.0", "info": "https://www.apache.org/licenses/LICENSE-2.0"} -{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://badge.fury.io/py/mlx.warnings.svg", "info": "https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=5.4.1&x2=0"} -{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 301, "uri": "https://badge.fury.io/py/mlx.warnings", "info": "https://pypi.org/project/mlx.warnings/"} {"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://bestpractices.coreinfrastructure.org/projects/4368/badge", "info": "https://www.bestpractices.dev/projects/4368/badge"} +{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 301, "uri": "https://badge.fury.io/py/mlx.warnings", "info": "https://pypi.org/project/mlx.warnings/"} +{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://badge.fury.io/py/mlx.warnings.svg", "info": "https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=5.5.0&x2=0"} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://codeclimate.com/github/melexis/warnings-plugin", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://codecov.io/gh/melexis/warnings-plugin/branch/master/graph/badge.svg", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://codeclimate.com/github/melexis/warnings-plugin/badges/issue_count.svg", "info": ""} -{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 301, "uri": "https://codecov.io/gh/melexis/warnings-plugin", "info": "https://app.codecov.io/gh/melexis/warnings-plugin"} -{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://bestpractices.coreinfrastructure.org/projects/4368", "info": "https://www.bestpractices.dev/en/projects/4368"} -{"filename": "readme.rst", "lineno": 407, "status": "working", "code": 0, "uri": "https://docs.python.org/3/library/string.html#string.Template.template", "info": ""} -{"filename": "readme.rst", "lineno": 571, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/testing/code_quality.html", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://codeclimate.com/github/melexis/warnings-plugin/badges/gpa.svg", "info": "https://api.codeclimate.com/v1/badges/c287cf98885a503c8a09/maintainability.svg"} -{"filename": "readme.rst", "lineno": 571, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool", "info": ""} -{"filename": "readme.rst", "lineno": 571, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscodequality", "info": ""} +{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 302, "uri": "https://bestpractices.coreinfrastructure.org/projects/4368", "info": "https://www.bestpractices.dev/en/projects/4368"} +{"filename": "readme.rst", "lineno": 224, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/testing/code_quality.html", "info": ""} +{"filename": "readme.rst", "lineno": null, "status": "redirected", "code": 301, "uri": "https://codecov.io/gh/melexis/warnings-plugin", "info": "https://app.codecov.io/gh/melexis/warnings-plugin"} +{"filename": "readme.rst", "lineno": 408, "status": "working", "code": 0, "uri": "https://docs.python.org/3/library/string.html#string.Template.template", "info": ""} +{"filename": "readme.rst", "lineno": 572, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool", "info": ""} +{"filename": "readme.rst", "lineno": 572, "status": "working", "code": 0, "uri": "https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscodequality", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://github.com/melexis/warnings-plugin/actions/workflows/python-package.yml/badge.svg?branch=master", "info": ""} {"filename": "readme.rst", "lineno": 46, "status": "working", "code": 0, "uri": "https://github.com/jenkinsci/warnings-plugin", "info": ""} -{"filename": "contributing.rst", "lineno": 3, "status": "redirected", "code": 302, "uri": "https://guides.github.com/introduction/flow/", "info": "https://docs.github.com/en/get-started/using-github/github-flow"} -{"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://img.shields.io/badge/Documentation-published-brightgreen.svg", "info": ""} -{"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://melexis.github.io/warnings-plugin/", "info": ""} +{"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat", "info": ""} +{"filename": "contributing.rst", "lineno": 3, "status": "redirected", "code": 302, "uri": "https://guides.github.com/introduction/flow/", "info": "https://docs.github.com/en/get-started/using-github/github-flow"} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://img.shields.io/hexpm/l/plug.svg", "info": ""} -{"filename": "readme.rst", "lineno": 63, "status": "working", "code": 0, "uri": "https://melexis.github.io/warnings-plugin/installation.html", "info": ""} -{"filename": "installation.rst", "lineno": 5, "status": "working", "code": 0, "uri": "https://pypi.org/project/mlx.warnings/", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://github.com/melexis/warnings-plugin/issues", "info": ""} -{"filename": "readme.rst", "lineno": 377, "status": "working", "code": 0, "uri": "https://nl.mathworks.com/help/polyspace_access/ug/fix-or-comment-polyspace-results-web-browser.html", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://github.com/melexis/warnings-plugin/actions/workflows/python-package.yml", "info": ""} -{"filename": "readme.rst", "lineno": 309, "status": "working", "code": 0, "uri": "https://robotframework.org/", "info": ""} -{"filename": "readme.rst", "lineno": 284, "status": "working", "code": 0, "uri": "https://github.com/xmlrunner/unittest-xml-reporting", "info": ""} -{"filename": "readme.rst", "lineno": 407, "status": "working", "code": 0, "uri": "https://yaml.org/spec/1.2.2/", "info": ""} +{"filename": "installation.rst", "lineno": 5, "status": "working", "code": 0, "uri": "https://pypi.org/project/mlx.warnings/", "info": ""} +{"filename": "readme.rst", "lineno": 63, "status": "working", "code": 0, "uri": "https://melexis.github.io/warnings-plugin/installation.html", "info": ""} +{"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://melexis.github.io/warnings-plugin/", "info": ""} +{"filename": "readme.rst", "lineno": 285, "status": "working", "code": 0, "uri": "https://github.com/xmlrunner/unittest-xml-reporting", "info": ""} +{"filename": "readme.rst", "lineno": 378, "status": "working", "code": 0, "uri": "https://nl.mathworks.com/help/polyspace_access/ug/fix-or-comment-polyspace-results-web-browser.html", "info": ""} +{"filename": "readme.rst", "lineno": 310, "status": "working", "code": 0, "uri": "https://robotframework.org/", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://scan.coverity.com/projects/15266/badge.svg", "info": ""} -{"filename": "readme.rst", "lineno": 309, "status": "working", "code": 0, "uri": "https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#xunit-compatible-result-file", "info": ""} +{"filename": "readme.rst", "lineno": 408, "status": "working", "code": 0, "uri": "https://yaml.org/spec/1.2.2/", "info": ""} {"filename": "readme.rst", "lineno": null, "status": "working", "code": 0, "uri": "https://scan.coverity.com/projects/melexis-warnings-plugin", "info": ""} +{"filename": "readme.rst", "lineno": 310, "status": "working", "code": 0, "uri": "https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#xunit-compatible-result-file", "info": ""} diff --git a/output.txt b/output.txt index 4bc647c8..5473ef4f 100644 --- a/output.txt +++ b/output.txt @@ -1,8 +1,8 @@ readme.rst:None: [redirected permanently] http://www.apache.org/licenses/LICENSE-2.0 to https://www.apache.org/licenses/LICENSE-2.0 -readme.rst:None: [redirected with Found] https://badge.fury.io/py/mlx.warnings.svg to https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=5.4.1&x2=0 -readme.rst:None: [redirected permanently] https://badge.fury.io/py/mlx.warnings to https://pypi.org/project/mlx.warnings/ readme.rst:None: [redirected with Found] https://bestpractices.coreinfrastructure.org/projects/4368/badge to https://www.bestpractices.dev/projects/4368/badge -readme.rst:None: [redirected permanently] https://codecov.io/gh/melexis/warnings-plugin to https://app.codecov.io/gh/melexis/warnings-plugin -readme.rst:None: [redirected with Found] https://bestpractices.coreinfrastructure.org/projects/4368 to https://www.bestpractices.dev/en/projects/4368 +readme.rst:None: [redirected permanently] https://badge.fury.io/py/mlx.warnings to https://pypi.org/project/mlx.warnings/ +readme.rst:None: [redirected with Found] https://badge.fury.io/py/mlx.warnings.svg to https://d25lcipzij17d.cloudfront.net/badge.svg?id=py&r=r&ts=1683906897&type=6e&v=5.5.0&x2=0 readme.rst:None: [redirected with Found] https://codeclimate.com/github/melexis/warnings-plugin/badges/gpa.svg to https://api.codeclimate.com/v1/badges/c287cf98885a503c8a09/maintainability.svg +readme.rst:None: [redirected with Found] https://bestpractices.coreinfrastructure.org/projects/4368 to https://www.bestpractices.dev/en/projects/4368 +readme.rst:None: [redirected permanently] https://codecov.io/gh/melexis/warnings-plugin to https://app.codecov.io/gh/melexis/warnings-plugin contributing.rst:3: [redirected with Found] https://guides.github.com/introduction/flow/ to https://docs.github.com/en/get-started/using-github/github-flow diff --git a/py-modindex.html b/py-modindex.html index ed636f66..21c9f596 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index — warning-plugin 5.5.0 documentation + Python Module Index — warning-plugin 5.5.1 documentation @@ -33,7 +33,7 @@

    Navigation

    @@ -129,7 +129,7 @@

    Navigation

    diff --git a/readme.html b/readme.html index 36b8b988..716aaf94 100644 --- a/readme.html +++ b/readme.html @@ -5,7 +5,7 @@ - Command Line Warnings Plugin — warning-plugin 5.5.0 documentation + Command Line Warnings Plugin — warning-plugin 5.5.1 documentation @@ -33,7 +33,7 @@

    Navigation

    @@ -137,14 +137,14 @@

    Parse for Sphinx Warnings
    # command line log file
     mlx-warnings doc_log.txt --sphinx
     # command line command execution
    -mlx-warnings --sphinx --command <commandforsphinx>
    +mlx-warnings --sphinx --command <command-for-sphinx>
     
     # explicitly as python module for log file
     python3 -m mlx.warnings --sphinx doc_log.txt
     python -m mlx.warnings --sphinx doc_log.txt
     # explicitly as python module
    -python3 -m mlx.warnings --sphinx --command <commandforsphinx>
    -python -m mlx.warnings --sphinx --command <commandforsphinx>
    +python3 -m mlx.warnings --sphinx --command <command-for-sphinx>
    +python -m mlx.warnings --sphinx --command <command-for-sphinx>
     
    @@ -155,77 +155,79 @@

    Parse for Doxygen Warnings
    # command line log file
     mlx-warnings doc_log.txt --doxygen
     # command line command execution
    -mlx-warnings --doxygen --command <commandfordoxygen>
    +mlx-warnings --doxygen --command <command-for-doxygen>
     
     # explicitly as python module for log file
     python3 -m mlx.warnings --doxygen doc_log.txt
     python -m mlx.warnings --doxygen doc_log.txt
     # explicitly as python module
    -python3 -m mlx.warnings --doxygen --command <commandfordoxygen>
    -python -m mlx.warnings --doxygen --command <commandfordoxygen>
    +python3 -m mlx.warnings --doxygen --command <command-for-doxygen>
    +python -m mlx.warnings --doxygen --command <command-for-doxygen>
     

    Parse for Coverity Defects

    -

    Coverity is a static analysis tool which has option to run desktop analysis +

    Coverity is a static analysis tool that includes a CLI tool to run desktop analysis on your local changes and report the results back directly in the console. You only need to list affected files and below example lists changed files -between your branch and master, which it then forwards to cov-run-desktop:

    -
    cov-run-desktop --text-output-style=oneline `git diff --name-only --ignore-submodules master`
    +between your source and target branch, e.g. ‘main’, which it then forwards to cov-run-desktop:

    +
    cov-run-desktop --text-output-style=oneline `git diff --name-only --ignore-submodules main`
     
    -

    You can pipe the results to logfile, which you pass to warnings-plugin, or you use -the --command argument and execute the cov-run-desktop through

    +

    You can either pipe the results to a log file and pass it to the warnings-plugin, or you can use +the --command argument to let the plugin invoke cov-run-desktop.

    # command line log file
     mlx-warnings --coverity cov-run-desktop-output.txt
     # command line command execution
    -mlx-warnings --coverity --command <commandforcoverity>
    +mlx-warnings --coverity --command <command-for-coverity>
     
     # explicitly as python module for log file
     python3 -m mlx.warnings --coverity cov-run-desktop-output.txt
     python -m mlx.warnings --coverity cov-run-desktop-output.txt
     # explicitly as python module
    -python3 -m mlx.warnings --coverity --command <commandforcoverity>
    -python -m mlx.warnings --coverity --command <commandforcoverity>
    +python3 -m mlx.warnings --coverity --command <command-for-coverity>
    +python -m mlx.warnings --coverity --command <command-for-coverity>
     
    -

    We utilize cov-run-desktop in the following manner, where the output is saved in coverity.log:

    -
    cov-run-desktop --text-output-style=oneline --exit1-if-defects false --triage-attribute-regex "classification" ".*" <coverity_files> | tee coverity.log
    +

    The command below demonstrates how we utilize cov-run-desktop:

    +
    cov-run-desktop --text-output-style=oneline --exit1-if-defects false --triage-attribute-regex "classification" ".*" <coverity_files> | tee raw_defects.log
     
    -

    Subsequently, we process the coverity.log file with the mlx-warnings plugin. -The plugin uses a configuration file (warnings_coverity.yml) and produces two outputs: -a text file (warnings_coverity.txt) and a code quality JSON file (coverity_code_quality.json).

    -
    mlx-warnings --config warnings_coverity.yml -o warnings_coverity.txt -C coverity_code_quality.json coverity.log
    +

    Then, the mlx-warnings plugin processes the output log file, raw_defects.log, based on the optional configuration file +config.yml to produce three outputs:

    +
      +
    • A text file that contains all counted Coverity defects.

    • +
    • A Code Quality report report.json that contains all counted Coverity defects.

    • +
    • A return code equal to the amount of counted Coverity defects. The value is 0 if the amount of Coverity defects is +within limits. We use this return code to determine whether our CI job passes or fails.

    • +
    +
    mlx-warnings --config config.yml --output counted_defects.txt --code-quality report.json raw_defects.log
     
    -

    This is an example of the configuration file:

    -
    sphinx:
    -    enabled: false
    -doxygen:
    -    enabled: false
    -junit:
    -    enabled: false
    -xmlrunner:
    -    enabled: false
    -coverity:
    +

    Below is an example configuration for the Coverity checker:

    +
    coverity:
         enabled: true
    -    intentional:
    -        max: -1
    -    bug:
    -        max: 0
    +    unclassified:
    +      max: 0
         pending:
    -        max: 0
    +      max: 0
    +    bug:
    +      min: 2
    +      max: 2
         false_positive:
    -        max: -1
    -robot:
    -    enabled: false
    -polyspace:
    -    enabled: false
    +      max: -1
    +    intentional:
    +      max: -1
     
    -

    For each classification, a minimum and maximum can be given.

    +

    As you can see, we have configured limits for 5 out of 5 Coverity Classifications. You can configure a minimum and a +maximum limit for the number of allowed Coverity defects that belong to the Classification. +The default value for both limits is 0. +A value of -1 for max corresponds to effectively no limit (an infinite amount). +If one or more Classifications are missing from your configuration, the Coverity defects are counted and 0 are +allowed. To ignore certain classifications, modify the value for +cov-run-desktop –triage-attribute-regex “classification”.

    @@ -259,14 +261,14 @@

    Parse for XMLRunner Errors
    # command line log file
     mlx-warnings xmlrunner_log.txt --xmlrunner
     # command line command execution
    -mlx-warnings --xmlrunner --command <commandforxmlrunner>
    +mlx-warnings --xmlrunner --command <command-for-xmlrunner>
     
     # explicitly as python module for log file
     python3 -m mlx.warnings --xmlrunner xmlrunner_log.txt
     python -m mlx.warnings --xmlrunner xmlrunner_log.txt
     # explicitly as python module
    -python3 -m mlx.warnings --xmlrunner --command <commandforxmlrunner>
    -python -m mlx.warnings --xmlrunner --command <commandforxmlrunner>
    +python3 -m mlx.warnings --xmlrunner --command <command-for-xmlrunner>
    +python -m mlx.warnings --xmlrunner --command <command-for-xmlrunner>
     
    @@ -431,7 +433,7 @@

    Configuration File to Pass Options
    # command line log file
     mlx-warnings --config path/to/config.json junit_output.xml
     # command line command execution
    -mlx-warnings --config path/to/config.json --command <commandforjunit>
    +mlx-warnings --config path/to/config.json --command <command-for-junit>
     
    @@ -500,7 +502,7 @@

    Store All Counted Warnings

    Code Quality Report

    Use -C, --code-quality to let the plugin generate a Code Quality report for GitLab CI. All counted -Sphinx, Doxygen, XMLRunner and Polyspace warnings/errors/failures will be included. Other checker types are not yet supported by this feature. The report is +Sphinx, Doxygen, XMLRunner, Coverity and Polyspace warnings/errors/failures will be included. Other checker types are not yet supported by this feature. The report is a JSON file that implements a subset of the Code Climate spec. Define this file as a codequality report artifact of the CI job.

    If a warning doesn’t contain a path, "cq_default_path" from the configuration file to pass options will be used. @@ -616,7 +618,7 @@

    Navigation

    diff --git a/search.html b/search.html index 195ae0d1..b514636c 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search — warning-plugin 5.5.0 documentation + Search — warning-plugin 5.5.1 documentation @@ -36,7 +36,7 @@

    Navigation

    @@ -128,7 +128,7 @@

    Navigation

    diff --git a/searchindex.js b/searchindex.js index 172bed55..8551a459 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["authors", "contributing", "design", "index", "installation", "readme"], "filenames": ["authors.rst", "contributing.rst", "design.rst", "index.rst", "installation.rst", "readme.rst"], "titles": ["Authors", "Contribution Guide", "Software Design", "Contents", "Installation Guide", "Command Line Warnings Plugin"], "terms": {"melexi": [0, 2, 4, 5], "warn": [0, 1, 2, 3, 4], "plugin": [0, 1, 2, 3, 4], "i": [0, 1, 2, 4, 5], "mainli": 0, "maintain": 0, "bavo": 0, "van": 0, "acht": 0, "crt": 0, "mori": 0, "stein": 0, "heselman": 0, "jasper": 0, "craegh": 0, "anyon": [1, 5], "more": [1, 2, 5], "than": 1, "welcom": 1, "develop": [1, 5], "matter": [1, 5], "your": [1, 5], "program": 1, "skill": 1, "level": [1, 2], "It": [1, 5], "": [1, 2, 5], "oblig": 1, "help": [1, 5], "bring": 1, "our": [1, 2, 5], "desir": 1, "you": [1, 4, 5], "should": [1, 5], "do": [1, 5], "best": 1, "understand": 1, "decis": 1, "standard": 1, "github": [1, 4, 5], "flow": 1, "us": [1, 2, 5], "http": [1, 4, 5], "com": [1, 4, 5], "introduct": 1, "pull": 1, "which": [1, 2, 5], "ar": [1, 2, 4, 5], "merg": 1, "we": [1, 2, 4, 5], "also": [1, 5], "prefer": 1, "make": 1, "work": 1, "In": [1, 5], "progress": 1, "onc": [1, 4], "just": [1, 5], "case": [1, 2, 4, 5], "someon": 1, "els": [1, 2], "same": [1, 5], "There": [1, 5], "mai": [1, 5], "few": [1, 5], "open": [1, 2, 4, 5], "some": [1, 5], "own": 1, "suggest": [1, 5], "The": [1, 2, 5], "want": [1, 2, 5], "label": 1, "indic": [1, 5], "an": [1, 4, 5], "easi": 1, "enough": 1, "task": 1, "so": [1, 2, 4, 5], "go": 1, "pick": 1, "up": 1, "feel": 1, "most": 1, "excit": 1, "about": [1, 5], "implement": [1, 2, 5], "all": [1, 2], "need": [1, 2, 4, 5], "properli": 1, "test": [1, 2], "target": [1, 2], "coverag": 1, "percentag": 1, "rather": 1, "focu": 1, "regress": 1, "confirm": 1, "expect": [1, 2], "function": [1, 2, 5], "border": 1, "thi": [1, 2, 5], "u": [1, 5], "keep": [1, 5], "exist": [1, 2, 5], "even": [1, 5], "after": [1, 2, 5], "year": 1, "constant": 1, "fix": 1, "bug": [1, 5], "basic": [1, 5], "everi": [1, 5], "bit": 1, "detail": [1, 5], "can": [1, 2, 5], "includ": [1, 2, 5], "futur": 1, "might": [1, 5], "look": [1, 5], "obviou": 1, "everyon": 1, "correctli": 1, "intend": 1, "thei": [1, 5], "aspect": 1, "check": [1, 2], "benefit": 1, "from": [1, 2, 4, 5], "fresh": 1, "ey": 1, "improv": 1, "rememb": 1, "act": 1, "polit": 1, "sinc": [1, 5], "peopl": 1, "frequent": 1, "contributor": 1, "variou": [1, 5], "repositori": [1, 5], "intimid": 1, "them": [1, 5], "learn": 1, "pleas": [1, 2, 4, 5], "have": [1, 4, 5], "ani": [1, 4, 5], "problem": [1, 4, 5], "happi": 1, "soon": 1, "possibl": [1, 5], "If": [1, 2, 5], "know": 1, "where": [1, 2, 5], "enhanc": 1, "when": [1, 2, 5], "time": [1, 5], "fit": 1, "view": 1, "convent": 2, "plain": 2, "python": [2, 4, 5], "everywher": 2, "convert": 2, "anyth": 2, "exampl": [2, 3], "junitpars": 2, "byte": 2, "arrai": 2, "object": 2, "encod": 2, "right": 2, "befor": 2, "pass": [2, 3], "fork": 2, "mlx": [2, 4], "coveritycheck": 2, "verbos": 2, "fals": [2, 5], "sourc": [2, 5], "base": [2, 4], "regexcheck": 2, "content": 2, "count": 2, "number": [2, 5], "adopt": 2, "cover": 2, "output": [2, 5], "paramet": 2, "str": 2, "pars": 2, "properti": 2, "counted_warn": 2, "list": [2, 5], "type": [2, 5], "cq_description_templ": [2, 5], "templat": [2, 5], "instanc": 2, "configur": [2, 3], "name": [2, 5], "parse_config": 2, "config": [2, 5], "process": [2, 5], "dict": 2, "file": [2, 3], "pattern": [2, 5], "re": 2, "compil": 2, "p": 2, "path": [2, 5], "d": [2, 5], "w": 2, "_": 2, "line": [2, 3, 4], "column": [2, 5], "cid": [2, 5], "curr": 2, "max": [2, 5], "checker": [2, 5], "classif": [2, 5], "return_check_limit": 2, "whether": 2, "within": [2, 5], "limit": [2, 5], "return": [2, 5], "int": 2, "0": [2, 5], "amount": [2, 5], "otherwis": [2, 5], "1": [2, 5], "return_count": 2, "getter": 2, "found": [2, 5], "doxycheck": 2, "doxygen": 2, "path1": 2, "A": 2, "za": 2, "z": 2, "line1": 2, "severity1": 2, "ww": 2, "arn": 2, "ee": 2, "rror": 2, "line2": 2, "severity2": 2, "description1": 2, "nn": 2, "otic": 2, "junitcheck": 2, "warningscheck": 2, "junit": 2, "failur": 2, "specif": [2, 5], "text": [2, 5], "static": [2, 5], "prepare_tre": 2, "root_input": 2, "prepar": 2, "tree": 2, "element": 2, "ad": [2, 5], "testsuit": 2, "root": 2, "miss": [2, 5], "junitxml": 2, "lxml": 2, "etre": 2, "_element": 2, "xml": [2, 5], "elementtre": 2, "top": 2, "input": [2, 5], "tag": 2, "polyspacecheck": 2, "tsv": [2, 5], "export": 2, "polyspac": 2, "_io": 2, "textiowrapp": 2, "maximum": [2, 5], "get": [2, 3, 5], "highest": 2, "minimum": [2, 5], "lowest": 2, "extract": 2, "previous": 2, "json": [2, 5], "yaml": [2, 5], "yml": [2, 5], "arg": 2, "rais": [2, 5], "valueerror": 2, "valu": [2, 5], "kei": [2, 5], "repres": [2, 5], "famili": [2, 5], "These": [2, 5], "consist": [2, 5], "3": 2, "pair": 2, "note": [2, 5], "min": [2, 5], "defin": [2, 5], "default": [2, 5], "value_to_check": 2, "polyspacefamilycheck": 2, "family_valu": 2, "column_nam": 2, "check_valu": 2, "kwarg": 2, "add_code_quality_find": 2, "row": [2, 5], "add": [2, 5], "code": [2, 3], "qualiti": [2, 3], "find": [2, 5], "correspond": [2, 5], "colomn": 2, "csv": [2, 5], "code_quality_sever": 2, "impact": [2, 5], "high": [2, 5], "critic": 2, "low": [2, 5], "minor": 2, "medium": [2, 5], "major": 2, "orang": [2, 5], "red": [2, 5], "robotcheck": 2, "robot": 2, "framework": 2, "suit": [2, 5], "robotsuitecheck": 2, "check_suite_nam": [2, 5], "classnam": 2, "doe": 2, "end": 2, "attribut": [2, 5], "ignor": [2, 5], "systemexit": 2, "No": [2, 5], "self": 2, "error": 2, "sphinxcheck": 2, "include_sphinx_deprec": 2, "sphinx_deprecation_regex": 2, "alter": 2, "main": 2, "sphinx": 2, "m": [2, 5], "none": 2, "debug": 2, "info": 2, "sever": [2, 5], "multilin": 2, "sphinx_deprecation_regex_in_match": 2, "removedinsphinx": [2, 5], "add_pattern": 2, "regex": 2, "pattern_contain": 2, "specifi": [2, 5], "contain": [2, 5], "storag": 2, "abstract": 2, "print_when_verbos": 2, "messag": [2, 5], "print": [2, 5], "onli": [2, 5], "mode": 2, "enabl": [2, 5], "condition": 2, "except": 2, "warningsconfigerror": 2, "warningsplugin": 2, "config_fil": 2, "cq_enabl": 2, "activate_check": 2, "activ": [2, 5], "addit": 2, "initi": [2, 5], "activate_checker_nam": 2, "given": [2, 5], "check_logfil": 2, "config_pars": 2, "configure_maximum": 2, "each": [2, 5], "allow": [2, 5], "configure_minimum": 2, "get_check": 2, "determin": 2, "script": [2, 5], "set": [2, 5], "regist": 2, "sum": 2, "toggle_printout": 2, "printout": 2, "toggl": 2, "command": [2, 3, 4], "well": [2, 5], "bool": 2, "true": [2, 5], "provid": [2, 5], "silent": 2, "write_code_quality_report": 2, "out_fil": 2, "gener": [2, 5], "report": [2, 3], "artifact": [2, 5], "subset": [2, 5], "climat": [2, 5], "spec": [2, 5], "locat": 2, "write_counted_warn": 2, "write": [2, 5], "xmlrunnercheck": 2, "xmlrunner": 2, "fail": [2, 5], "n": 2, "warnings_wrapp": 2, "instal": 3, "usag": 3, "pipe": 3, "run": [3, 4], "simpl": [3, 4], "option": 3, "other": 3, "issu": [3, 4], "new": 3, "featur": 3, "contribut": 3, "guid": [3, 5], "softwar": 3, "design": 3, "class": 3, "diagram": 3, "string": [3, 5], "handl": [3, 5], "instrument": 3, "modul": [3, 5], "start": [3, 5], "document": [3, 5], "review": 3, "request": 3, "author": 3, "index": 3, "search": 3, "page": 3, "avail": [4, 5], "packag": [4, 5], "pypi": 4, "offer": 4, "direct": [4, 5], "invoc": 4, "infront": 4, "releas": [4, 5], "version": [4, 5], "pip3": [4, 5], "edit": 4, "master": [4, 5], "branch": [4, 5], "git": [4, 5], "clone": 4, "e": [4, 5], "far": 4, "awar": [4, 5], "altern": 5, "jenkinsci": 5, "useabl": 5, "less": 5, "ci": 5, "system": 5, "gitlab": 5, "threshold": 5, "job": 5, "tool": 5, "upload": 5, "pip": 5, "simpli": 5, "python3": 5, "log": 5, "stream": 5, "creat": 5, "redirect": 5, "stderr": 5, "shell": 5, "argument": 5, "support": 5, "instead": 5, "Be": 5, "stdout": 5, "last": 5, "discard": 5, "becaus": 5, "consid": 5, "without": 5, "flag": 5, "below": 5, "one": 5, "wai": 5, "save": 5, "insid": 5, "yourcommand": 5, "2": 5, "tee": 5, "doc_log": 5, "txt": 5, "mind": 5, "requir": 5, "plai": 5, "comput": 5, "virtualenv": 5, "separ": 5, "per": 5, "project": 5, "chanc": 5, "depend": 5, "hell": 5, "virtual": 5, "environ": 5, "current": 5, "directori": 5, "call": 5, "directli": 5, "consol": 5, "h": 5, "ha": 5, "like": 5, "variabl": 5, "suppli": 5, "ok": 5, "posit": 5, "counter": 5, "those": 5, "two": 5, "form": 5, "individu": 5, "flexibl": 5, "traceabl": 5, "resid": 5, "adjust": 5, "execut": 5, "commandforsphinx": 5, "explicitli": 5, "commandfordoxygen": 5, "analysi": 5, "desktop": 5, "local": 5, "chang": 5, "back": 5, "affect": 5, "between": 5, "forward": 5, "cov": 5, "style": 5, "onelin": 5, "diff": 5, "submodul": 5, "logfil": 5, "through": 5, "commandforcover": 5, "util": 5, "follow": 5, "manner": 5, "exit1": 5, "triag": 5, "coverity_fil": 5, "subsequ": 5, "warnings_cover": 5, "produc": 5, "coverity_code_qu": 5, "o": 5, "c": 5, "intent": 5, "pend": 5, "false_posit": 5, "For": 5, "multipl": 5, "junit_output": 5, "commandforjunit": 5, "mark": 5, "exit": 5, "could": 5, "detect": 5, "did": 5, "now": 5, "xmlrunner_log": 5, "commandforxmlrunn": 5, "xunit": 5, "compat": 5, "By": 5, "taken": 5, "account": 5, "care": 5, "doesn": 5, "t": 5, "mean": 5, "instruct": 5, "format": 5, "dir": 5, "resultsfold": 5, "export_opt": 5, "host": 5, "hostnam": 5, "id": 5, "runid": 5, "polyspace_access_opt": 5, "tab": 5, "inform": 5, "r2024a": 5, "group": 5, "color": 5, "statu": 5, "comment": 5, "col": 5, "previou": 5, "yet": 5, "cannot": 5, "togeth": 5, "prover": 5, "finder": 5, "status": 5, "altogeth": 5, "justifi": 5, "Not": 5, "due": 5, "consider": 5, "describ": 5, "action": 5, "plan": 5, "treat": 5, "differ": 5, "annot": 5, "global": 5, "demonstr": 5, "how": 5, "configuration_fil": 5, "tsv_file": 5, "code_qu": 5, "besid": 5, "structur": 5, "via": 5, "g": 5, "max_sphinx_warn": 5, "cq_default_path": 5, "doc": 5, "conf": 5, "py": 5, "product": 5, "descript": 5, "doxyfil": 5, "min_doxy_warn": 5, "max_doxy_warn": 5, "my": 5, "first": 5, "8": 5, "10": 5, "second": 5, "tdummy_funct": 5, "tdummy_file_nam": 5, "checkernam": 5, "boolean": 5, "expans": 5, "To": 5, "under": 5, "fast": 5, "import": 5, "still": 5, "accept": 5, "success": 5, "exact": 5, "singl": 5, "certain": 5, "regular": 5, "express": 5, "basi": 5, "won": 5, "toctre": 5, "against": 5, "concaten": 5, "cell": 5, "charact": 5, "backslash": 5, "escap": 5, "syntax": 5, "special": 5, "let": 5, "behavior": 5, "file_path": 5, "irrelev": 5, "codequ": 5, "fallback": 5, "custom": 5, "see": 5, "Its": 5, "access": 5, "home": 5, "field": 5, "titl": 5, "lowercas": 5, "fingerprint": 5, "uniqu": 5, "identifi": 5, "transient": 5, "remain": 5, "hash": 5, "md5": 5, "mani": 5, "valid": 5, "resolv": 5, "faster": 5, "would": 5, "hear": 5, "continu": 5, "integr": 5, "better": 5, "involv": 5, "encourag": 5}, "objects": {"mlx": [[2, 0, 0, "-", "warnings"]], "mlx.warnings": [[2, 1, 1, "", "CoverityChecker"], [2, 1, 1, "", "DoxyChecker"], [2, 1, 1, "", "JUnitChecker"], [2, 1, 1, "", "PolyspaceChecker"], [2, 1, 1, "", "PolyspaceFamilyChecker"], [2, 1, 1, "", "RobotChecker"], [2, 1, 1, "", "RobotSuiteChecker"], [2, 1, 1, "", "SphinxChecker"], [2, 1, 1, "", "WarningsChecker"], [2, 5, 1, "", "WarningsConfigError"], [2, 1, 1, "", "WarningsPlugin"], [2, 1, 1, "", "XMLRunnerChecker"], [2, 6, 1, "", "warnings_wrapper"]], "mlx.warnings.CoverityChecker": [[2, 2, 1, "", "check"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 4, 1, "", "pattern"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.DoxyChecker": [[2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"]], "mlx.warnings.JUnitChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "name"], [2, 2, 1, "", "prepare_tree"]], "mlx.warnings.PolyspaceChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "checkers"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.PolyspaceFamilyChecker": [[2, 2, 1, "", "add_code_quality_finding"], [2, 2, 1, "", "check"], [2, 4, 1, "", "code_quality_severity"], [2, 3, 1, "", "cq_description_template"], [2, 2, 1, "", "return_count"]], "mlx.warnings.RobotChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "checkers"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.RobotSuiteChecker": [[2, 2, 1, "", "check"], [2, 2, 1, "", "return_count"]], "mlx.warnings.SphinxChecker": [[2, 2, 1, "", "include_sphinx_deprecation"], [2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"], [2, 4, 1, "", "sphinx_deprecation_regex"], [2, 4, 1, "", "sphinx_deprecation_regex_in_match"]], "mlx.warnings.WarningsChecker": [[2, 2, 1, "", "add_patterns"], [2, 2, 1, "", "check"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "print_when_verbose"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.WarningsPlugin": [[2, 2, 1, "", "activate_checker"], [2, 2, 1, "", "activate_checker_name"], [2, 2, 1, "", "check"], [2, 2, 1, "", "check_logfile"], [2, 2, 1, "", "config_parser"], [2, 2, 1, "", "configure_maximum"], [2, 2, 1, "", "configure_minimum"], [2, 2, 1, "", "get_checker"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"], [2, 2, 1, "", "toggle_printout"], [2, 2, 1, "", "write_code_quality_report"], [2, 2, 1, "", "write_counted_warnings"]], "mlx.warnings.XMLRunnerChecker": [[2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:exception", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "exception", "Python exception"], "6": ["py", "function", "Python function"]}, "titleterms": {"author": 0, "contribut": [1, 5], "guid": [1, 4], "get": 1, "start": 1, "qualiti": [1, 5], "document": 1, "code": [1, 5], "review": 1, "report": [1, 5], "issu": [1, 5], "request": 1, "new": [1, 5], "featur": [1, 5], "softwar": 2, "design": 2, "class": 2, "diagram": 2, "string": 2, "handl": 2, "instrument": 2, "modul": 2, "content": 3, "indic": 3, "tabl": 3, "instal": [4, 5], "command": 5, "line": 5, "warn": 5, "plugin": 5, "usag": 5, "pipe": 5, "exampl": 5, "run": 5, "simpl": 5, "option": 5, "pars": 5, "sphinx": 5, "doxygen": 5, "cover": 5, "defect": 5, "junit": 5, "failur": 5, "xmlrunner": 5, "error": 5, "robot": 5, "framework": 5, "test": 5, "polyspac": 5, "export": 5, "result": 5, "configur": 5, "check": 5, "mlx": 5, "file": 5, "pass": 5, "other": 5, "exclud": 5, "match": 5, "With": 5, "regex": 5, "deprec": 5, "store": 5, "all": 5, "count": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"Authors": [[0, "authors"]], "Contribution Guide": [[1, "contribution-guide"]], "Getting Started": [[1, "getting-started"]], "Quality of Contribution": [[1, "quality-of-contribution"]], "Documentation": [[1, "documentation"]], "Code Review": [[1, "code-review"]], "Reporting Issues or Requesting a New Feature": [[1, "reporting-issues-or-requesting-a-new-feature"]], "Software Design": [[2, "software-design"]], "Class Diagram": [[2, "class-diagram"]], "String Handling": [[2, "string-handling"]], "Instrument Module": [[2, "module-mlx.warnings"]], "Contents": [[3, "contents"]], "Indices and Tables": [[3, "indices-and-tables"]], "Installation Guide": [[4, "installation-guide"]], "Command Line Warnings Plugin": [[5, "command-line-warnings-plugin"]], "Installation": [[5, "installation"]], "Usage": [[5, "usage"]], "Pipe Example": [[5, "pipe-example"]], "Command Example": [[5, "command-example"]], "Running Command": [[5, "running-command"]], "Simple Command Line Options": [[5, "simple-command-line-options"]], "Parse for Sphinx Warnings": [[5, "parse-for-sphinx-warnings"]], "Parse for Doxygen Warnings": [[5, "parse-for-doxygen-warnings"]], "Parse for Coverity Defects": [[5, "parse-for-coverity-defects"]], "Parse for JUnit Failures": [[5, "parse-for-junit-failures"]], "Parse for XMLRunner Errors": [[5, "parse-for-xmlrunner-errors"]], "Parse for Robot Framework Test Failures": [[5, "parse-for-robot-framework-test-failures"]], "Parse for Polyspace Failures": [[5, "parse-for-polyspace-failures"]], "Exporting Polyspace Results": [[5, "exporting-polyspace-results"]], "Configuration": [[5, "configuration"]], "Example Checks": [[5, "example-checks"]], "Running the mlx-warnings plugin": [[5, "running-the-mlx-warnings-plugin"]], "Configuration File to Pass Options": [[5, "configuration-file-to-pass-options"]], "Other Options": [[5, "other-options"]], "Exclude Matches With Regexes": [[5, "exclude-matches-with-regexes"]], "Exclude Sphinx Deprecation Warnings": [[5, "exclude-sphinx-deprecation-warnings"]], "Store All Counted Warnings": [[5, "store-all-counted-warnings"]], "Code Quality Report": [[5, "code-quality-report"]], "Issues and New Features": [[5, "issues-and-new-features"]], "Contribute": [[5, "contribute"]]}, "indexentries": {"coveritychecker (class in mlx.warnings)": [[2, "mlx.warnings.CoverityChecker"]], "doxychecker (class in mlx.warnings)": [[2, "mlx.warnings.DoxyChecker"]], "junitchecker (class in mlx.warnings)": [[2, "mlx.warnings.JUnitChecker"]], "polyspacechecker (class in mlx.warnings)": [[2, "mlx.warnings.PolyspaceChecker"]], "polyspacefamilychecker (class in mlx.warnings)": [[2, "mlx.warnings.PolyspaceFamilyChecker"]], "robotchecker (class in mlx.warnings)": [[2, "mlx.warnings.RobotChecker"]], "robotsuitechecker (class in mlx.warnings)": [[2, "mlx.warnings.RobotSuiteChecker"]], "sphinxchecker (class in mlx.warnings)": [[2, "mlx.warnings.SphinxChecker"]], "warningschecker (class in mlx.warnings)": [[2, "mlx.warnings.WarningsChecker"]], "warningsconfigerror": [[2, "mlx.warnings.WarningsConfigError"]], "warningsplugin (class in mlx.warnings)": [[2, "mlx.warnings.WarningsPlugin"]], "xmlrunnerchecker (class in mlx.warnings)": [[2, "mlx.warnings.XMLRunnerChecker"]], "activate_checker() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.activate_checker"]], "activate_checker_name() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.activate_checker_name"]], "add_code_quality_finding() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.add_code_quality_finding"]], "add_patterns() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.add_patterns"]], "check() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.check"]], "check() (mlx.warnings.junitchecker method)": [[2, "mlx.warnings.JUnitChecker.check"]], "check() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.check"]], "check() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.check"]], "check() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.check"]], "check() (mlx.warnings.robotsuitechecker method)": [[2, "mlx.warnings.RobotSuiteChecker.check"]], "check() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.check"]], "check() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.check"]], "check_logfile() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.check_logfile"]], "checkers (mlx.warnings.polyspacechecker attribute)": [[2, "mlx.warnings.PolyspaceChecker.checkers"]], "checkers (mlx.warnings.robotchecker attribute)": [[2, "mlx.warnings.RobotChecker.checkers"]], "code_quality_severity (mlx.warnings.polyspacefamilychecker attribute)": [[2, "mlx.warnings.PolyspaceFamilyChecker.code_quality_severity"]], "config_parser() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.config_parser"]], "configure_maximum() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.configure_maximum"]], "configure_minimum() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.configure_minimum"]], "counted_warnings (mlx.warnings.coveritychecker property)": [[2, "mlx.warnings.CoverityChecker.counted_warnings"]], "counted_warnings (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.counted_warnings"]], "counted_warnings (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.counted_warnings"]], "counted_warnings (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.counted_warnings"]], "cq_description_template (mlx.warnings.coveritychecker property)": [[2, "mlx.warnings.CoverityChecker.cq_description_template"]], "cq_description_template (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.cq_description_template"]], "cq_description_template (mlx.warnings.polyspacefamilychecker property)": [[2, "mlx.warnings.PolyspaceFamilyChecker.cq_description_template"]], "cq_description_template (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.cq_description_template"]], "get_checker() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.get_checker"]], "include_sphinx_deprecation() (mlx.warnings.sphinxchecker method)": [[2, "mlx.warnings.SphinxChecker.include_sphinx_deprecation"]], "maximum (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.maximum"]], "maximum (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.maximum"]], "maximum (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.maximum"]], "minimum (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.minimum"]], "minimum (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.minimum"]], "minimum (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.minimum"]], "mlx.warnings": [[2, "module-mlx.warnings"]], "module": [[2, "module-mlx.warnings"]], "name (mlx.warnings.coveritychecker attribute)": [[2, "mlx.warnings.CoverityChecker.name"]], "name (mlx.warnings.doxychecker attribute)": [[2, "mlx.warnings.DoxyChecker.name"]], "name (mlx.warnings.junitchecker attribute)": [[2, "mlx.warnings.JUnitChecker.name"]], "name (mlx.warnings.polyspacechecker attribute)": [[2, "mlx.warnings.PolyspaceChecker.name"]], "name (mlx.warnings.robotchecker attribute)": [[2, "mlx.warnings.RobotChecker.name"]], "name (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.name"]], "name (mlx.warnings.warningschecker attribute)": [[2, "mlx.warnings.WarningsChecker.name"]], "name (mlx.warnings.xmlrunnerchecker attribute)": [[2, "mlx.warnings.XMLRunnerChecker.name"]], "parse_config() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.parse_config"]], "parse_config() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.parse_config"]], "parse_config() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.parse_config"]], "parse_config() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.parse_config"]], "pattern (mlx.warnings.coveritychecker attribute)": [[2, "mlx.warnings.CoverityChecker.pattern"]], "pattern (mlx.warnings.doxychecker attribute)": [[2, "mlx.warnings.DoxyChecker.pattern"]], "pattern (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.pattern"]], "pattern (mlx.warnings.xmlrunnerchecker attribute)": [[2, "mlx.warnings.XMLRunnerChecker.pattern"]], "prepare_tree() (mlx.warnings.junitchecker static method)": [[2, "mlx.warnings.JUnitChecker.prepare_tree"]], "print_when_verbose() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.print_when_verbose"]], "return_check_limits() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.return_check_limits"]], "return_count() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.return_count"]], "return_count() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.return_count"]], "return_count() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.return_count"]], "return_count() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.return_count"]], "return_count() (mlx.warnings.robotsuitechecker method)": [[2, "mlx.warnings.RobotSuiteChecker.return_count"]], "return_count() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.return_count"]], "return_count() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.return_count"]], "sphinx_deprecation_regex (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.sphinx_deprecation_regex"]], "sphinx_deprecation_regex_in_match (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.sphinx_deprecation_regex_in_match"]], "toggle_printout() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.toggle_printout"]], "warnings_wrapper() (in module mlx.warnings)": [[2, "mlx.warnings.warnings_wrapper"]], "write_code_quality_report() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.write_code_quality_report"]], "write_counted_warnings() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.write_counted_warnings"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["authors", "contributing", "design", "index", "installation", "readme"], "filenames": ["authors.rst", "contributing.rst", "design.rst", "index.rst", "installation.rst", "readme.rst"], "titles": ["Authors", "Contribution Guide", "Software Design", "Contents", "Installation Guide", "Command Line Warnings Plugin"], "terms": {"melexi": [0, 2, 4, 5], "warn": [0, 1, 2, 3, 4], "plugin": [0, 1, 2, 3, 4], "i": [0, 1, 2, 4, 5], "mainli": 0, "maintain": 0, "bavo": 0, "van": 0, "acht": 0, "crt": 0, "mori": 0, "stein": 0, "heselman": 0, "jasper": 0, "craegh": 0, "anyon": [1, 5], "more": [1, 2, 5], "than": 1, "welcom": 1, "develop": [1, 5], "matter": [1, 5], "your": [1, 5], "program": 1, "skill": 1, "level": [1, 2], "It": [1, 5], "": [1, 2, 5], "oblig": 1, "help": [1, 5], "bring": 1, "our": [1, 2, 5], "desir": 1, "you": [1, 4, 5], "should": [1, 5], "do": [1, 5], "best": 1, "understand": 1, "decis": 1, "standard": 1, "github": [1, 4, 5], "flow": 1, "us": [1, 2, 5], "http": [1, 4, 5], "com": [1, 4, 5], "introduct": 1, "pull": 1, "which": [1, 2, 5], "ar": [1, 2, 4, 5], "merg": 1, "we": [1, 2, 4, 5], "also": [1, 5], "prefer": 1, "make": 1, "work": 1, "In": [1, 5], "progress": 1, "onc": [1, 4], "just": [1, 5], "case": [1, 2, 4, 5], "someon": 1, "els": [1, 2], "same": [1, 5], "There": [1, 5], "mai": [1, 5], "few": [1, 5], "open": [1, 2, 4, 5], "some": [1, 5], "own": 1, "suggest": [1, 5], "The": [1, 2, 5], "want": [1, 2, 5], "label": 1, "indic": [1, 5], "an": [1, 4, 5], "easi": 1, "enough": 1, "task": 1, "so": [1, 2, 4, 5], "go": 1, "pick": 1, "up": 1, "feel": 1, "most": 1, "excit": 1, "about": [1, 5], "implement": [1, 2, 5], "all": [1, 2], "need": [1, 2, 4, 5], "properli": 1, "test": [1, 2], "target": [1, 2, 5], "coverag": 1, "percentag": 1, "rather": 1, "focu": 1, "regress": 1, "confirm": 1, "expect": [1, 2], "function": [1, 2, 5], "border": 1, "thi": [1, 2, 5], "u": [1, 5], "keep": [1, 5], "exist": [1, 2, 5], "even": [1, 5], "after": [1, 2, 5], "year": 1, "constant": 1, "fix": 1, "bug": [1, 5], "basic": [1, 5], "everi": [1, 5], "bit": 1, "detail": [1, 5], "can": [1, 2, 5], "includ": [1, 2, 5], "futur": 1, "might": [1, 5], "look": [1, 5], "obviou": 1, "everyon": 1, "correctli": 1, "intend": 1, "thei": [1, 5], "aspect": 1, "check": [1, 2], "benefit": 1, "from": [1, 2, 4, 5], "fresh": 1, "ey": 1, "improv": 1, "rememb": 1, "act": 1, "polit": 1, "sinc": [1, 5], "peopl": 1, "frequent": 1, "contributor": 1, "variou": [1, 5], "repositori": [1, 5], "intimid": 1, "them": [1, 5], "learn": 1, "pleas": [1, 2, 4, 5], "have": [1, 4, 5], "ani": [1, 4, 5], "problem": [1, 4, 5], "happi": 1, "soon": 1, "possibl": [1, 5], "If": [1, 2, 5], "know": 1, "where": [1, 2], "enhanc": 1, "when": [1, 2, 5], "time": [1, 5], "fit": 1, "view": 1, "convent": 2, "plain": 2, "python": [2, 4, 5], "everywher": 2, "convert": 2, "anyth": 2, "exampl": [2, 3], "junitpars": 2, "byte": 2, "arrai": 2, "object": 2, "encod": 2, "right": 2, "befor": 2, "pass": [2, 3], "fork": 2, "mlx": [2, 4], "coveritycheck": 2, "verbos": 2, "fals": [2, 5], "sourc": [2, 5], "base": [2, 4, 5], "regexcheck": 2, "content": 2, "count": 2, "number": [2, 5], "adopt": 2, "cover": 2, "output": [2, 5], "paramet": 2, "str": 2, "pars": 2, "properti": 2, "counted_warn": 2, "list": [2, 5], "type": [2, 5], "cq_description_templ": [2, 5], "templat": [2, 5], "instanc": 2, "configur": [2, 3], "cq_find": 2, "code": [2, 3], "qualiti": [2, 3], "find": [2, 5], "dict": 2, "name": [2, 5], "parse_config": 2, "config": [2, 5], "process": [2, 5], "file": [2, 3], "pattern": [2, 5], "re": 2, "compil": 2, "p": 2, "path": [2, 5], "d": [2, 5], "w": 2, "_": 2, "line": [2, 3, 4], "column": [2, 5], "cid": [2, 5], "curr": 2, "max": [2, 5], "checker": [2, 5], "classif": [2, 5], "return_check_limit": 2, "whether": [2, 5], "within": [2, 5], "limit": [2, 5], "return": [2, 5], "int": 2, "0": [2, 5], "amount": [2, 5], "otherwis": [2, 5], "1": [2, 5], "return_count": 2, "getter": 2, "found": [2, 5], "doxycheck": 2, "doxygen": 2, "path1": 2, "A": [2, 5], "za": 2, "z": 2, "line1": 2, "severity1": 2, "ww": 2, "arn": 2, "ee": 2, "rror": 2, "line2": 2, "severity2": 2, "description1": 2, "nn": 2, "otic": 2, "junitcheck": 2, "warningscheck": 2, "junit": 2, "failur": 2, "specif": [2, 5], "text": [2, 5], "static": [2, 5], "prepare_tre": 2, "root_input": 2, "prepar": 2, "tree": 2, "element": 2, "ad": [2, 5], "testsuit": 2, "root": 2, "miss": [2, 5], "junitxml": 2, "lxml": 2, "etre": 2, "_element": 2, "xml": [2, 5], "elementtre": 2, "top": 2, "input": [2, 5], "tag": 2, "polyspacecheck": 2, "tsv": [2, 5], "export": 2, "polyspac": 2, "_io": 2, "textiowrapp": 2, "maximum": [2, 5], "get": [2, 3, 5], "highest": 2, "minimum": [2, 5], "lowest": 2, "extract": 2, "previous": 2, "json": [2, 5], "yaml": [2, 5], "yml": [2, 5], "arg": 2, "rais": [2, 5], "valueerror": 2, "valu": [2, 5], "kei": [2, 5], "repres": [2, 5], "famili": [2, 5], "These": [2, 5], "consist": [2, 5], "3": 2, "pair": 2, "note": [2, 5], "min": [2, 5], "defin": [2, 5], "default": [2, 5], "value_to_check": 2, "polyspacefamilycheck": 2, "family_valu": 2, "column_nam": 2, "check_valu": 2, "kwarg": 2, "add_code_quality_find": 2, "row": [2, 5], "add": [2, 5], "correspond": [2, 5], "colomn": 2, "csv": [2, 5], "code_quality_sever": 2, "impact": [2, 5], "high": [2, 5], "critic": 2, "low": [2, 5], "minor": 2, "medium": [2, 5], "major": 2, "orang": [2, 5], "red": [2, 5], "robotcheck": 2, "robot": 2, "framework": 2, "suit": [2, 5], "robotsuitecheck": 2, "check_suite_nam": [2, 5], "classnam": 2, "doe": 2, "end": 2, "attribut": [2, 5], "ignor": [2, 5], "systemexit": 2, "No": [2, 5], "self": 2, "error": 2, "sphinxcheck": 2, "include_sphinx_deprec": 2, "sphinx_deprecation_regex": 2, "alter": 2, "main": [2, 5], "sphinx": 2, "m": [2, 5], "none": 2, "debug": 2, "info": 2, "sever": [2, 5], "multilin": 2, "sphinx_deprecation_regex_in_match": 2, "removedinsphinx": [2, 5], "add_pattern": 2, "regex": 2, "pattern_contain": 2, "specifi": [2, 5], "contain": [2, 5], "storag": 2, "abstract": 2, "print_when_verbos": 2, "messag": [2, 5], "print": [2, 5], "onli": [2, 5], "mode": 2, "enabl": [2, 5], "condition": 2, "except": 2, "warningsconfigerror": 2, "warningsplugin": 2, "config_fil": 2, "cq_enabl": 2, "activate_check": 2, "activ": [2, 5], "addit": 2, "initi": [2, 5], "activate_checker_nam": 2, "given": [2, 5], "check_logfil": 2, "config_pars": 2, "configure_maximum": 2, "each": [2, 5], "allow": [2, 5], "configure_minimum": 2, "get_check": 2, "determin": [2, 5], "script": [2, 5], "set": [2, 5], "regist": 2, "sum": 2, "toggle_printout": 2, "printout": 2, "toggl": 2, "command": [2, 3, 4], "well": [2, 5], "bool": 2, "true": [2, 5], "provid": [2, 5], "silent": 2, "write_code_quality_report": 2, "out_fil": 2, "gener": [2, 5], "report": [2, 3], "artifact": [2, 5], "subset": [2, 5], "climat": [2, 5], "spec": [2, 5], "locat": 2, "write_counted_warn": 2, "write": [2, 5], "xmlrunnercheck": 2, "xmlrunner": 2, "fail": [2, 5], "n": 2, "warnings_wrapp": 2, "instal": 3, "usag": 3, "pipe": 3, "run": [3, 4], "simpl": [3, 4], "option": 3, "other": 3, "issu": [3, 4], "new": 3, "featur": 3, "contribut": 3, "guid": [3, 5], "softwar": 3, "design": 3, "class": 3, "diagram": 3, "string": [3, 5], "handl": [3, 5], "instrument": 3, "modul": [3, 5], "start": [3, 5], "document": [3, 5], "review": 3, "request": 3, "author": 3, "index": 3, "search": 3, "page": 3, "avail": [4, 5], "packag": [4, 5], "pypi": 4, "offer": 4, "direct": [4, 5], "invoc": 4, "infront": 4, "releas": [4, 5], "version": [4, 5], "pip3": [4, 5], "edit": 4, "master": 4, "branch": [4, 5], "git": [4, 5], "clone": 4, "e": [4, 5], "far": 4, "awar": [4, 5], "altern": 5, "jenkinsci": 5, "useabl": 5, "less": 5, "ci": 5, "system": 5, "gitlab": 5, "threshold": 5, "job": 5, "tool": 5, "upload": 5, "pip": 5, "simpli": 5, "python3": 5, "log": 5, "stream": 5, "creat": 5, "redirect": 5, "stderr": 5, "shell": 5, "argument": 5, "support": 5, "instead": 5, "Be": 5, "stdout": 5, "last": 5, "discard": 5, "becaus": 5, "consid": 5, "without": 5, "flag": 5, "below": 5, "one": 5, "wai": 5, "save": 5, "insid": 5, "yourcommand": 5, "2": 5, "tee": 5, "doc_log": 5, "txt": 5, "mind": 5, "requir": 5, "plai": 5, "comput": 5, "virtualenv": 5, "separ": 5, "per": 5, "project": 5, "chanc": 5, "depend": 5, "hell": 5, "virtual": 5, "environ": 5, "current": 5, "directori": 5, "call": 5, "directli": 5, "consol": 5, "h": 5, "ha": 5, "like": 5, "variabl": 5, "suppli": 5, "ok": 5, "posit": 5, "counter": 5, "those": 5, "two": 5, "form": 5, "individu": 5, "flexibl": 5, "traceabl": 5, "resid": 5, "adjust": 5, "execut": 5, "explicitli": 5, "analysi": 5, "cli": 5, "desktop": 5, "local": 5, "chang": 5, "back": 5, "affect": 5, "between": 5, "g": 5, "forward": 5, "cov": 5, "style": 5, "onelin": 5, "diff": 5, "submodul": 5, "either": 5, "let": 5, "invok": 5, "demonstr": 5, "how": 5, "util": 5, "exit1": 5, "triag": 5, "coverity_fil": 5, "raw_defect": 5, "Then": 5, "produc": 5, "three": 5, "equal": 5, "counted_defect": 5, "unclassifi": 5, "pend": 5, "false_posit": 5, "intent": 5, "As": 5, "see": 5, "5": 5, "out": 5, "belong": 5, "both": 5, "effect": 5, "infinit": 5, "To": 5, "certain": 5, "modifi": 5, "multipl": 5, "junit_output": 5, "mark": 5, "exit": 5, "could": 5, "detect": 5, "did": 5, "now": 5, "xmlrunner_log": 5, "xunit": 5, "compat": 5, "By": 5, "taken": 5, "account": 5, "care": 5, "doesn": 5, "t": 5, "mean": 5, "instruct": 5, "follow": 5, "format": 5, "dir": 5, "resultsfold": 5, "export_opt": 5, "host": 5, "hostnam": 5, "id": 5, "runid": 5, "polyspace_access_opt": 5, "tab": 5, "inform": 5, "r2024a": 5, "group": 5, "color": 5, "statu": 5, "comment": 5, "col": 5, "previou": 5, "yet": 5, "cannot": 5, "togeth": 5, "For": 5, "prover": 5, "finder": 5, "status": 5, "altogeth": 5, "justifi": 5, "Not": 5, "due": 5, "consider": 5, "describ": 5, "action": 5, "plan": 5, "treat": 5, "differ": 5, "annot": 5, "global": 5, "configuration_fil": 5, "tsv_file": 5, "code_qu": 5, "besid": 5, "through": 5, "structur": 5, "via": 5, "max_sphinx_warn": 5, "cq_default_path": 5, "doc": 5, "conf": 5, "py": 5, "product": 5, "descript": 5, "doxyfil": 5, "min_doxy_warn": 5, "max_doxy_warn": 5, "my": 5, "first": 5, "8": 5, "10": 5, "second": 5, "tdummy_funct": 5, "tdummy_file_nam": 5, "c": 5, "checkernam": 5, "boolean": 5, "expans": 5, "under": 5, "fast": 5, "import": 5, "still": 5, "accept": 5, "success": 5, "exact": 5, "singl": 5, "regular": 5, "express": 5, "basi": 5, "won": 5, "toctre": 5, "against": 5, "concaten": 5, "cell": 5, "charact": 5, "backslash": 5, "escap": 5, "syntax": 5, "special": 5, "behavior": 5, "o": 5, "file_path": 5, "irrelev": 5, "codequ": 5, "fallback": 5, "custom": 5, "Its": 5, "access": 5, "home": 5, "field": 5, "titl": 5, "lowercas": 5, "fingerprint": 5, "uniqu": 5, "identifi": 5, "transient": 5, "remain": 5, "hash": 5, "md5": 5, "mani": 5, "valid": 5, "resolv": 5, "faster": 5, "would": 5, "hear": 5, "continu": 5, "integr": 5, "better": 5, "involv": 5, "encourag": 5}, "objects": {"mlx": [[2, 0, 0, "-", "warnings"]], "mlx.warnings": [[2, 1, 1, "", "CoverityChecker"], [2, 1, 1, "", "DoxyChecker"], [2, 1, 1, "", "JUnitChecker"], [2, 1, 1, "", "PolyspaceChecker"], [2, 1, 1, "", "PolyspaceFamilyChecker"], [2, 1, 1, "", "RobotChecker"], [2, 1, 1, "", "RobotSuiteChecker"], [2, 1, 1, "", "SphinxChecker"], [2, 1, 1, "", "WarningsChecker"], [2, 5, 1, "", "WarningsConfigError"], [2, 1, 1, "", "WarningsPlugin"], [2, 1, 1, "", "XMLRunnerChecker"], [2, 6, 1, "", "warnings_wrapper"]], "mlx.warnings.CoverityChecker": [[2, 2, 1, "", "check"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 3, 1, "", "cq_findings"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 4, 1, "", "pattern"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.DoxyChecker": [[2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"]], "mlx.warnings.JUnitChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "name"], [2, 2, 1, "", "prepare_tree"]], "mlx.warnings.PolyspaceChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "checkers"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 3, 1, "", "cq_findings"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.PolyspaceFamilyChecker": [[2, 2, 1, "", "add_code_quality_finding"], [2, 2, 1, "", "check"], [2, 4, 1, "", "code_quality_severity"], [2, 3, 1, "", "cq_description_template"], [2, 2, 1, "", "return_count"]], "mlx.warnings.RobotChecker": [[2, 2, 1, "", "check"], [2, 4, 1, "", "checkers"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.RobotSuiteChecker": [[2, 2, 1, "", "check"], [2, 2, 1, "", "return_count"]], "mlx.warnings.SphinxChecker": [[2, 2, 1, "", "include_sphinx_deprecation"], [2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"], [2, 4, 1, "", "sphinx_deprecation_regex"], [2, 4, 1, "", "sphinx_deprecation_regex_in_match"]], "mlx.warnings.WarningsChecker": [[2, 2, 1, "", "add_patterns"], [2, 2, 1, "", "check"], [2, 3, 1, "", "counted_warnings"], [2, 3, 1, "", "cq_description_template"], [2, 3, 1, "", "cq_findings"], [2, 3, 1, "", "maximum"], [2, 3, 1, "", "minimum"], [2, 4, 1, "", "name"], [2, 2, 1, "", "parse_config"], [2, 2, 1, "", "print_when_verbose"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"]], "mlx.warnings.WarningsPlugin": [[2, 2, 1, "", "activate_checker"], [2, 2, 1, "", "activate_checker_name"], [2, 2, 1, "", "check"], [2, 2, 1, "", "check_logfile"], [2, 2, 1, "", "config_parser"], [2, 2, 1, "", "configure_maximum"], [2, 2, 1, "", "configure_minimum"], [2, 2, 1, "", "get_checker"], [2, 2, 1, "", "return_check_limits"], [2, 2, 1, "", "return_count"], [2, 2, 1, "", "toggle_printout"], [2, 2, 1, "", "write_code_quality_report"], [2, 2, 1, "", "write_counted_warnings"]], "mlx.warnings.XMLRunnerChecker": [[2, 4, 1, "", "name"], [2, 4, 1, "", "pattern"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:attribute", "5": "py:exception", "6": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "exception", "Python exception"], "6": ["py", "function", "Python function"]}, "titleterms": {"author": 0, "contribut": [1, 5], "guid": [1, 4], "get": 1, "start": 1, "qualiti": [1, 5], "document": 1, "code": [1, 5], "review": 1, "report": [1, 5], "issu": [1, 5], "request": 1, "new": [1, 5], "featur": [1, 5], "softwar": 2, "design": 2, "class": 2, "diagram": 2, "string": 2, "handl": 2, "instrument": 2, "modul": 2, "content": 3, "indic": 3, "tabl": 3, "instal": [4, 5], "command": 5, "line": 5, "warn": 5, "plugin": 5, "usag": 5, "pipe": 5, "exampl": 5, "run": 5, "simpl": 5, "option": 5, "pars": 5, "sphinx": 5, "doxygen": 5, "cover": 5, "defect": 5, "junit": 5, "failur": 5, "xmlrunner": 5, "error": 5, "robot": 5, "framework": 5, "test": 5, "polyspac": 5, "export": 5, "result": 5, "configur": 5, "check": 5, "mlx": 5, "file": 5, "pass": 5, "other": 5, "exclud": 5, "match": 5, "With": 5, "regex": 5, "deprec": 5, "store": 5, "all": 5, "count": 5}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 57}, "alltitles": {"Authors": [[0, "authors"]], "Contribution Guide": [[1, "contribution-guide"]], "Getting Started": [[1, "getting-started"]], "Quality of Contribution": [[1, "quality-of-contribution"]], "Documentation": [[1, "documentation"]], "Code Review": [[1, "code-review"]], "Reporting Issues or Requesting a New Feature": [[1, "reporting-issues-or-requesting-a-new-feature"]], "Software Design": [[2, "software-design"]], "Class Diagram": [[2, "class-diagram"]], "String Handling": [[2, "string-handling"]], "Instrument Module": [[2, "module-mlx.warnings"]], "Contents": [[3, "contents"]], "Indices and Tables": [[3, "indices-and-tables"]], "Installation Guide": [[4, "installation-guide"]], "Command Line Warnings Plugin": [[5, "command-line-warnings-plugin"]], "Installation": [[5, "installation"]], "Usage": [[5, "usage"]], "Pipe Example": [[5, "pipe-example"]], "Command Example": [[5, "command-example"]], "Running Command": [[5, "running-command"]], "Simple Command Line Options": [[5, "simple-command-line-options"]], "Parse for Sphinx Warnings": [[5, "parse-for-sphinx-warnings"]], "Parse for Doxygen Warnings": [[5, "parse-for-doxygen-warnings"]], "Parse for Coverity Defects": [[5, "parse-for-coverity-defects"]], "Parse for JUnit Failures": [[5, "parse-for-junit-failures"]], "Parse for XMLRunner Errors": [[5, "parse-for-xmlrunner-errors"]], "Parse for Robot Framework Test Failures": [[5, "parse-for-robot-framework-test-failures"]], "Parse for Polyspace Failures": [[5, "parse-for-polyspace-failures"]], "Exporting Polyspace Results": [[5, "exporting-polyspace-results"]], "Configuration": [[5, "configuration"]], "Example Checks": [[5, "example-checks"]], "Running the mlx-warnings plugin": [[5, "running-the-mlx-warnings-plugin"]], "Configuration File to Pass Options": [[5, "configuration-file-to-pass-options"]], "Other Options": [[5, "other-options"]], "Exclude Matches With Regexes": [[5, "exclude-matches-with-regexes"]], "Exclude Sphinx Deprecation Warnings": [[5, "exclude-sphinx-deprecation-warnings"]], "Store All Counted Warnings": [[5, "store-all-counted-warnings"]], "Code Quality Report": [[5, "code-quality-report"]], "Issues and New Features": [[5, "issues-and-new-features"]], "Contribute": [[5, "contribute"]]}, "indexentries": {"coveritychecker (class in mlx.warnings)": [[2, "mlx.warnings.CoverityChecker"]], "doxychecker (class in mlx.warnings)": [[2, "mlx.warnings.DoxyChecker"]], "junitchecker (class in mlx.warnings)": [[2, "mlx.warnings.JUnitChecker"]], "polyspacechecker (class in mlx.warnings)": [[2, "mlx.warnings.PolyspaceChecker"]], "polyspacefamilychecker (class in mlx.warnings)": [[2, "mlx.warnings.PolyspaceFamilyChecker"]], "robotchecker (class in mlx.warnings)": [[2, "mlx.warnings.RobotChecker"]], "robotsuitechecker (class in mlx.warnings)": [[2, "mlx.warnings.RobotSuiteChecker"]], "sphinxchecker (class in mlx.warnings)": [[2, "mlx.warnings.SphinxChecker"]], "warningschecker (class in mlx.warnings)": [[2, "mlx.warnings.WarningsChecker"]], "warningsconfigerror": [[2, "mlx.warnings.WarningsConfigError"]], "warningsplugin (class in mlx.warnings)": [[2, "mlx.warnings.WarningsPlugin"]], "xmlrunnerchecker (class in mlx.warnings)": [[2, "mlx.warnings.XMLRunnerChecker"]], "activate_checker() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.activate_checker"]], "activate_checker_name() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.activate_checker_name"]], "add_code_quality_finding() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.add_code_quality_finding"]], "add_patterns() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.add_patterns"]], "check() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.check"]], "check() (mlx.warnings.junitchecker method)": [[2, "mlx.warnings.JUnitChecker.check"]], "check() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.check"]], "check() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.check"]], "check() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.check"]], "check() (mlx.warnings.robotsuitechecker method)": [[2, "mlx.warnings.RobotSuiteChecker.check"]], "check() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.check"]], "check() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.check"]], "check_logfile() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.check_logfile"]], "checkers (mlx.warnings.polyspacechecker attribute)": [[2, "mlx.warnings.PolyspaceChecker.checkers"]], "checkers (mlx.warnings.robotchecker attribute)": [[2, "mlx.warnings.RobotChecker.checkers"]], "code_quality_severity (mlx.warnings.polyspacefamilychecker attribute)": [[2, "mlx.warnings.PolyspaceFamilyChecker.code_quality_severity"]], "config_parser() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.config_parser"]], "configure_maximum() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.configure_maximum"]], "configure_minimum() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.configure_minimum"]], "counted_warnings (mlx.warnings.coveritychecker property)": [[2, "mlx.warnings.CoverityChecker.counted_warnings"]], "counted_warnings (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.counted_warnings"]], "counted_warnings (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.counted_warnings"]], "counted_warnings (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.counted_warnings"]], "cq_description_template (mlx.warnings.coveritychecker property)": [[2, "mlx.warnings.CoverityChecker.cq_description_template"]], "cq_description_template (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.cq_description_template"]], "cq_description_template (mlx.warnings.polyspacefamilychecker property)": [[2, "mlx.warnings.PolyspaceFamilyChecker.cq_description_template"]], "cq_description_template (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.cq_description_template"]], "cq_findings (mlx.warnings.coveritychecker property)": [[2, "mlx.warnings.CoverityChecker.cq_findings"]], "cq_findings (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.cq_findings"]], "cq_findings (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.cq_findings"]], "get_checker() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.get_checker"]], "include_sphinx_deprecation() (mlx.warnings.sphinxchecker method)": [[2, "mlx.warnings.SphinxChecker.include_sphinx_deprecation"]], "maximum (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.maximum"]], "maximum (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.maximum"]], "maximum (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.maximum"]], "minimum (mlx.warnings.polyspacechecker property)": [[2, "mlx.warnings.PolyspaceChecker.minimum"]], "minimum (mlx.warnings.robotchecker property)": [[2, "mlx.warnings.RobotChecker.minimum"]], "minimum (mlx.warnings.warningschecker property)": [[2, "mlx.warnings.WarningsChecker.minimum"]], "mlx.warnings": [[2, "module-mlx.warnings"]], "module": [[2, "module-mlx.warnings"]], "name (mlx.warnings.coveritychecker attribute)": [[2, "mlx.warnings.CoverityChecker.name"]], "name (mlx.warnings.doxychecker attribute)": [[2, "mlx.warnings.DoxyChecker.name"]], "name (mlx.warnings.junitchecker attribute)": [[2, "mlx.warnings.JUnitChecker.name"]], "name (mlx.warnings.polyspacechecker attribute)": [[2, "mlx.warnings.PolyspaceChecker.name"]], "name (mlx.warnings.robotchecker attribute)": [[2, "mlx.warnings.RobotChecker.name"]], "name (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.name"]], "name (mlx.warnings.warningschecker attribute)": [[2, "mlx.warnings.WarningsChecker.name"]], "name (mlx.warnings.xmlrunnerchecker attribute)": [[2, "mlx.warnings.XMLRunnerChecker.name"]], "parse_config() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.parse_config"]], "parse_config() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.parse_config"]], "parse_config() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.parse_config"]], "parse_config() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.parse_config"]], "pattern (mlx.warnings.coveritychecker attribute)": [[2, "mlx.warnings.CoverityChecker.pattern"]], "pattern (mlx.warnings.doxychecker attribute)": [[2, "mlx.warnings.DoxyChecker.pattern"]], "pattern (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.pattern"]], "pattern (mlx.warnings.xmlrunnerchecker attribute)": [[2, "mlx.warnings.XMLRunnerChecker.pattern"]], "prepare_tree() (mlx.warnings.junitchecker static method)": [[2, "mlx.warnings.JUnitChecker.prepare_tree"]], "print_when_verbose() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.print_when_verbose"]], "return_check_limits() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.return_check_limits"]], "return_check_limits() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.return_check_limits"]], "return_count() (mlx.warnings.coveritychecker method)": [[2, "mlx.warnings.CoverityChecker.return_count"]], "return_count() (mlx.warnings.polyspacechecker method)": [[2, "mlx.warnings.PolyspaceChecker.return_count"]], "return_count() (mlx.warnings.polyspacefamilychecker method)": [[2, "mlx.warnings.PolyspaceFamilyChecker.return_count"]], "return_count() (mlx.warnings.robotchecker method)": [[2, "mlx.warnings.RobotChecker.return_count"]], "return_count() (mlx.warnings.robotsuitechecker method)": [[2, "mlx.warnings.RobotSuiteChecker.return_count"]], "return_count() (mlx.warnings.warningschecker method)": [[2, "mlx.warnings.WarningsChecker.return_count"]], "return_count() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.return_count"]], "sphinx_deprecation_regex (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.sphinx_deprecation_regex"]], "sphinx_deprecation_regex_in_match (mlx.warnings.sphinxchecker attribute)": [[2, "mlx.warnings.SphinxChecker.sphinx_deprecation_regex_in_match"]], "toggle_printout() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.toggle_printout"]], "warnings_wrapper() (in module mlx.warnings)": [[2, "mlx.warnings.warnings_wrapper"]], "write_code_quality_report() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.write_code_quality_report"]], "write_counted_warnings() (mlx.warnings.warningsplugin method)": [[2, "mlx.warnings.WarningsPlugin.write_counted_warnings"]]}}) \ No newline at end of file