C++: Incorporate docs review comments

jbj · jbj · commit ca3554dcc622 · 2019-01-11T14:18:15.000+01:00
diff --git a/change-notes/1.20/analysis-cpp.md b/change-notes/1.20/analysis-cpp.md
@@ -8,7 +8,7 @@
 
 | **Query**                   | **Tags**  | **Purpose**                                                        |
 |-----------------------------|-----------|--------------------------------------------------------------------|
-| Use of string copy function in a condition (`cpp/string-copy-return-value-as-boolean`) | correctness | This rule flags calls to string copy functions used in conditions, where it's likely that a different function was intended to be called. |
+| Use of string copy function in a condition (`cpp/string-copy-return-value-as-boolean`) | correctness | This query identifies calls to string copy functions used in conditions, where it's likely that a different function was intended to be called. |
 
 ## Changes to existing queries
 
diff --git a/cpp/ql/src/Likely Bugs/Likely Typos/UsingStrcpyAsBoolean.qhelp b/cpp/ql/src/Likely Bugs/Likely Typos/UsingStrcpyAsBoolean.qhelp
@@ -4,7 +4,7 @@
 <qhelp>
 
 <overview>
-<p>This rule flags calls to string copy functions used in conditions, either
+<p>This query identifies calls to string copy functions used in conditions, either
 directly or as part of an equality operator or logical operator. The most
 common string copy functions always return their <code>destination</code>
 parameter and do not have a return value reserved to indicate an error.
@@ -39,7 +39,7 @@ context.</p>
 <references>
 <li>Microsoft Code Analysis for C/C++: <a href="https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2012/ccf4h9w8(v=vs.110)">C6324</a></li>
 <li>Microsoft C library reference: <a href="https://docs.microsoft.com/en-us/cpp/c-runtime-library/reference/strcpy-wcscpy-mbscpy">strcpy, wcscpy, _mbscpy</a></li>
-<li>US-CERT: <a href="https://www.us-cert.gov/bsi/articles/knowledge/coding-practices/strcpy_s-and-strcat_s">strncpy_s() and strncat_s()</a></li>
+<li>US-CERT: <a href="https://www.us-cert.gov/bsi/articles/knowledge/coding-practices/strcpy_s-and-strcat_s">strcpy_s() and strcat_s()</a></li>
 
 </references>
 </qhelp>
diff --git a/cpp/ql/src/Likely Bugs/Likely Typos/UsingStrcpyAsBoolean.ql b/cpp/ql/src/Likely Bugs/Likely Typos/UsingStrcpyAsBoolean.ql
@@ -37,7 +37,7 @@ predicate isStringCopyCastedAsBoolean(FunctionCall func, Expr expr1, string msg)
   DataFlow::localFlow(DataFlow::exprNode(func), DataFlow::exprNode(expr1)) and
   isBoolean(expr1.getConversion*()) and
   isStringComparisonFunction(func.getTarget().getName()) and
-  msg = "Return value of " + func.getTarget().getName() + " used as Boolean."
+  msg = "Return value of " + func.getTarget().getName() + " used as a Boolean."
 }
 
 predicate isStringCopyUsedInLogicalOperationOrCondition(FunctionCall func, Expr expr1, string msg) {
@@ -60,8 +60,7 @@ predicate isStringCopyUsedInLogicalOperationOrCondition(FunctionCall func, Expr
         func = ble.getAnOperand()
       )
     ) and
-    msg = "Return value of " + func.getTarget().getName() +
-        " used in a logical operation."
+    msg = "Return value of " + func.getTarget().getName() + " used in a logical operation."
     or
     // or the string copy function is used directly as the conditional expression
     (

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ predicate isStringCopyCastedAsBoolean(FunctionCall func, Expr expr1, string msg)`
`37`	`37`	`DataFlow::localFlow(DataFlow::exprNode(func), DataFlow::exprNode(expr1)) and`
`38`	`38`	`isBoolean(expr1.getConversion*()) and`
`39`	`39`	`isStringComparisonFunction(func.getTarget().getName()) and`
`40`		`- msg = "Return value of " + func.getTarget().getName() + " used as Boolean."`
	`40`	`+ msg = "Return value of " + func.getTarget().getName() + " used as a Boolean."`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`predicate isStringCopyUsedInLogicalOperationOrCondition(FunctionCall func, Expr expr1, string msg) {`
`@@ -60,8 +60,7 @@ predicate isStringCopyUsedInLogicalOperationOrCondition(FunctionCall func, Expr`
`60`	`60`	`func = ble.getAnOperand()`
`61`	`61`	`)`
`62`	`62`	`) and`
`63`		`- msg = "Return value of " + func.getTarget().getName() +`
`64`		`- " used in a logical operation."`
	`63`	`+ msg = "Return value of " + func.getTarget().getName() + " used in a logical operation."`
`65`	`64`	`or`
`66`	`65`	`// or the string copy function is used directly as the conditional expression`
`67`	`66`	`(`