Update Banned package meta data

rvermeulen · rvermeulen · commit 783f3375c965 · 2022-07-15T19:19:50.000+02:00
We updated the title, name, and description of queries to consistently
quote code elements, use the US variant behavior, and remove the angle
brackets from header file mentions.
diff --git a/c/cert/src/rules/ENV33-C/DoNotCallSystem.md b/c/cert/src/rules/ENV33-C/DoNotCallSystem.md
@@ -1,4 +1,4 @@
-# ENV33-C: Do not call system()
+# ENV33-C: Do not call 'system'
 
 This query implements the CERT-C rule ENV33-C:
 
diff --git a/c/cert/src/rules/ENV33-C/DoNotCallSystem.ql b/c/cert/src/rules/ENV33-C/DoNotCallSystem.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/cert/do-not-call-system
- * @name ENV33-C: Do not call system()
- * @description Use of the 'system()' function may result in exploitable vulnerabilities.
+ * @name ENV33-C: Do not call 'system'
+ * @description Use of the 'system' function may result in exploitable vulnerabilities.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-17-1/FeaturesOfStdarghUsed.ql b/c/misra/src/rules/RULE-17-1/FeaturesOfStdarghUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/features-of-stdargh-used
- * @name RULE-17-1: The features of <stdarg.h> shall not be used
- * @description The use of the features of '<stdarg.h> may result in undefined behaviour.
+ * @name RULE-17-1: The features of 'stdarg.h' shall not be used
+ * @description The use of the features of 'stdarg.h' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-19-2/UnionKeywordShouldNotBeUsed.ql b/c/misra/src/rules/RULE-19-2/UnionKeywordShouldNotBeUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/union-keyword-should-not-be-used
- * @name RULE-19-2: The union keyword should not be used
- * @description The use of 'union' may result in undefined behaviour.
+ * @name RULE-19-2: The 'union' keyword should not be used
+ * @description The use of 'union' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity warning
diff --git a/c/misra/src/rules/RULE-21-10/StandardLibraryTimeAndDateFunctionsUsed.ql b/c/misra/src/rules/RULE-21-10/StandardLibraryTimeAndDateFunctionsUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/standard-library-time-and-date-functions-used
  * @name RULE-21-10: The Standard Library time and date functions shall not be used
- * @description The use of date and time functions may result in undefined behaviour.
+ * @description The use of date and time functions may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-11/StandardHeaderFileTgmathhUsed.ql b/c/misra/src/rules/RULE-21-11/StandardHeaderFileTgmathhUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/standard-header-file-tgmathh-used
- * @name RULE-21-11: The standard header file <tgmath.h> shall not be used
- * @description The use of the header file '<tgmath.h>' may result in undefined behaviour.
+ * @name RULE-21-11: The standard header file 'tgmath.h' shall not be used
+ * @description The use of the header file 'tgmath.h' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-12/ExceptionHandlingFeaturesOfFenvhUsed.ql b/c/misra/src/rules/RULE-21-12/ExceptionHandlingFeaturesOfFenvhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/exception-handling-features-of-fenvh-used
- * @name RULE-21-12: The exception handling features of <fenv.h> should not be used
- * @description The use of the exception handling features of '<fenv.h>' may result in undefined
- *              behaviour.
+ * @name RULE-21-12: The exception handling features of 'fenv.h' should not be used
+ * @description The use of the exception handling features of 'fenv.h' may result in undefined
+ *              behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity warning
diff --git a/c/misra/src/rules/RULE-21-21/SystemOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-21/SystemOfStdlibhUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/system-of-stdlibh-used
- * @name RULE-21-21: The Standard Library function system of <stdlib.h> shall not be used
- * @description They use of the 'system()' function from '<stdlib.h> may result in exploitable
+ * @name RULE-21-21: The Standard Library function system of 'stdlib.h' shall not be used
+ * @description They use of the 'system()' function from 'stdlib.h' may result in exploitable
  *              vulnerabilities.
  * @kind problem
  * @precision very-high
diff --git a/c/misra/src/rules/RULE-21-3/MemoryAllocDeallocFunctionsOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-3/MemoryAllocDeallocFunctionsOfStdlibhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/memory-alloc-dealloc-functions-of-stdlibh-used
- * @name RULE-21-3: The memory allocation and deallocation functions of <stdlib.h> shall not be used
- * @description The use of memory allocation and deallocation in '<stdlib.h>' may result in
- *              undefined behaviour.
+ * @name RULE-21-3: The memory allocation and deallocation functions of 'stdlib.h' shall not be used
+ * @description The use of memory allocation and deallocation in 'stdlib.h' may result in undefined
+ *              behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-4/StandardHeaderFileUsedSetjmph.ql b/c/misra/src/rules/RULE-21-4/StandardHeaderFileUsedSetjmph.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/standard-header-file-used-setjmph
- * @name RULE-21-4: The standard header file shall not be used <setjmp.h>
- * @description The use of features of '<setjmp.h>' may result in undefined behaviour.
+ * @name RULE-21-4: The standard header file shall not be used 'setjmp.h'
+ * @description The use of features of 'setjmp.h' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-5/StandardHeaderFileUsedSignalh.ql b/c/misra/src/rules/RULE-21-5/StandardHeaderFileUsedSignalh.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/standard-header-file-used-signalh
- * @name RULE-21-5: The standard header file shall not be used <signal.h>
- * @description The use of features of '<signal.h>' may result in undefined behaviour.
+ * @name RULE-21-5: The standard header file shall not be used 'signal.h'
+ * @description The use of features of 'signal.h' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-6/StandardLibraryInputoutputFunctionsUsed.ql b/c/misra/src/rules/RULE-21-6/StandardLibraryInputoutputFunctionsUsed.ql
@@ -2,7 +2,7 @@
  * @id c/misra/standard-library-inputoutput-functions-used
  * @name RULE-21-6: The Standard Library input/output functions shall not be used
  * @description The use of the Standard Library input/output functions may result in undefined
- *              behaviour.
+ *              behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-7/AtofAtoiAtolAndAtollOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-7/AtofAtoiAtolAndAtollOfStdlibhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/atof-atoi-atol-and-atoll-of-stdlibh-used
- * @name RULE-21-7: The Standard Library functions atof, atoi, atol and atoll of <stdlib.h> shall not be used
- * @description The use of Standard Library functions atof, atoi, atol and atoll of <stdlib.h> may
- *              result in undefined behaviour.
+ * @name RULE-21-7: The Standard Library functions 'atof', 'atoi', 'atol' and 'atoll' of 'stdlib.h' shall not be used
+ * @description The use of Standard Library functions 'atof', 'atoi', 'atol' and 'atoll' of
+ *              'stdlib.h' may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-8/TerminationFunctionsOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-8/TerminationFunctionsOfStdlibhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/termination-functions-of-stdlibh-used
- * @name RULE-21-8: The Standard Library termination functions of <stdlib.h> shall not be used
- * @description The use of the Standard Library functions 'abort', 'exit' and 'system' of <stdlib.h>
- *              may result in undefined behaviour.
+ * @name RULE-21-8: The Standard Library termination functions of stdlib.h shall not be used
+ * @description The use of the Standard Library functions 'abort', 'exit' and 'system' of 'stdlib.h'
+ *              may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-21-8/TerminationMacrosOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-8/TerminationMacrosOfStdlibhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/termination-macros-of-stdlibh-used
- * @name RULE-21-8: The Standard Library termination macros of <stdlib.h> shall not be used
- * @description The use of the Standard Library macros 'abort', 'exit' and 'system' of <stdlib.h>
- *              may result in undefined behaviour.
+ * @name RULE-21-8: The Standard Library termination macros of 'stdlib.h' shall not be used
+ * @description The use of the Standard Library macros 'abort', 'exit' and 'system' of 'stdlib.h'
+ *              may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity warning
diff --git a/c/misra/src/rules/RULE-21-9/BsearchAndQsortOfStdlibhUsed.ql b/c/misra/src/rules/RULE-21-9/BsearchAndQsortOfStdlibhUsed.ql
@@ -1,8 +1,8 @@
 /**
  * @id c/misra/bsearch-and-qsort-of-stdlibh-used
- * @name RULE-21-9: The Standard Library functions bsearch and qsort of <stdlib.h> shall not be used
- * @description The use of the Standard Library functions 'bsearch' and 'qsort' of <stdlib.h> may
- *              result in undefined behaviour.
+ * @name RULE-21-9: The Standard Library functions 'bsearch' and 'qsort' of 'stdlib.h' shall not be used
+ * @description The use of the Standard Library functions 'bsearch' and 'qsort' of 'stdlib.h' may
+ *              result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-4-12/StdLibDynamicMemoryAllocationUsed.ql b/c/misra/src/rules/RULE-4-12/StdLibDynamicMemoryAllocationUsed.ql
@@ -1,9 +1,9 @@
 /**
  * @id c/misra/std-lib-dynamic-memory-allocation-used
  * @name RULE-4-12: Dynamic memory allocation shall not be used
- * @description Using dynamic memory allocation and deallocation can result to undefined behaviour.
+ * @description Using dynamic memory allocation and deallocation can result to undefined behavior.
  *              This query is for the Standard Library Implementation. Any implementation outside it
- *              will require a seperate query under the same directive
+ *              will require a separate query under the same directive
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/c/misra/src/rules/RULE-7-1/OctalConstantsUsed.ql b/c/misra/src/rules/RULE-7-1/OctalConstantsUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/octal-constants-used
  * @name RULE-7-1: Octal constants shall not be used
- * @description The use of octal constants affects the readbility of the program and should not be
+ * @description The use of octal constants affects the readability of the program and should not be
  *              used.
  * @kind problem
  * @precision very-high
diff --git a/c/misra/src/rules/RULE-8-14/RestrictTypeQualifierUsed.ql b/c/misra/src/rules/RULE-8-14/RestrictTypeQualifierUsed.ql
@@ -1,7 +1,7 @@
 /**
  * @id c/misra/restrict-type-qualifier-used
  * @name RULE-8-14: The restrict type qualifier shall not be used
- * @description The use of the 'restrict' type qualifier may result in undefined behaviour.
+ * @description The use of the 'restrict' type qualifier may result in undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/rule_packages/c/Banned.json b/rule_packages/c/Banned.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# ENV33-C: Do not call system()`
	`1`	`+# ENV33-C: Do not call 'system'`
`2`	`2`
`3`	`3`	`This query implements the CERT-C rule ENV33-C:`
`4`	`4`