Skip to content

Commit aeb1314

Browse files
authored
Merge pull request github#5275 from Marcono1234/marcono1234/included-qhelp-files
Use `.inc.qhelp` extension for included help files
2 parents f9f143d + 95aeb7b commit aeb1314

File tree

80 files changed

+70
-69
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+70
-69
lines changed

cpp/ql/src/Critical/DeadCodeCondition.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
It is likely that these conditions indicate an error in the branching condition.
1010
Alternatively, the conditions may have been left behind after debugging.</p>
1111

12-
<include src="aliasAnalysisWarning.qhelp" />
12+
<include src="aliasAnalysisWarning.inc.qhelp" />
1313
</overview>
1414

1515
<recommendation>

cpp/ql/src/Critical/DeadCodeFunction.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If left in the code base they increase object code size, decrease code comprehen
1313
This type of function may be part of the program's API and could be used by external programs.
1414
</p>
1515

16-
<include src="callGraphWarning.qhelp" />
16+
<include src="callGraphWarning.inc.qhelp" />
1717
</overview>
1818

1919
<recommendation>

cpp/ql/src/Critical/DescriptorMayNotBeClosed.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This query looks at functions that return file or socket descriptors, but may re
1010
This can occur when an operation performed on the open descriptor fails, and the function returns with an error before it closes the open resource. An improperly handled error could cause the function to leak resource descriptors. Failing to close resources in the function that opened them also makes it more difficult to detect leaks.
1111
</p>
1212

13-
<include src="dataFlowWarning.qhelp" />
13+
<include src="dataFlowWarning.inc.qhelp" />
1414
</overview>
1515

1616
<recommendation>

cpp/ql/src/Critical/DescriptorNeverClosed.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This rule finds calls to <code>socket</code> where there is no corresponding <co
1010
Leaving descriptors open will cause a resource leak that will persist even after the program terminates.
1111
</p>
1212

13-
<include src="aliasAnalysisWarning.qhelp" />
13+
<include src="aliasAnalysisWarning.inc.qhelp" />
1414
</overview>
1515

1616
<recommendation>

cpp/ql/src/Critical/FileMayNotBeClosed.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This rule looks at functions that return a <code>FILE*</code>, but may return an
1010
This can occur when an operation performed on the open descriptor fails, and the function returns with an error before closing the open resource. An improperly handled error may cause the function to leak file descriptors.
1111
</p>
1212

13-
<include src="dataFlowWarning.qhelp" />
13+
<include src="dataFlowWarning.inc.qhelp" />
1414

1515
</overview>
1616
<recommendation>

cpp/ql/src/Critical/FileNeverClosed.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This rule finds calls to <code>fopen</code> with no corresponding <code>fclose</
1010
Leaving files open will cause a resource leak that will persist even after the program terminates.
1111
</p>
1212

13-
<include src="aliasAnalysisWarning.qhelp" />
13+
<include src="aliasAnalysisWarning.inc.qhelp" />
1414

1515
</overview>
1616
<recommendation>

cpp/ql/src/Critical/GlobalUseBeforeInit.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Not all compilers generate code that zero-out memory, especially when optimizati
1010
is not compliant with the latest language standards. Accessing uninitialized memory will lead to undefined results.
1111
</p>
1212

13-
<include src="dataFlowWarning.qhelp" />
13+
<include src="dataFlowWarning.inc.qhelp" />
1414
</overview>
1515

1616
<recommendation>

cpp/ql/src/Critical/InconsistentNullnessTesting.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Dereferencing a null pointer and attempting to modify its contents can lead to a
1212
important system data (including the interrupt table in some architectures).
1313
</p>
1414

15-
<include src="pointsToWarning.qhelp" />
15+
<include src="pointsToWarning.inc.qhelp" />
1616
</overview>
1717

1818
<recommendation>

cpp/ql/src/Critical/InitialisationNotRun.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Uninitialized variables may contain any value, as not all compilers generate cod
1111
optimizations are enabled or the compiler is not compliant with the latest language standards.
1212
</p>
1313

14-
<include src="callGraphWarning.qhelp" />
14+
<include src="callGraphWarning.inc.qhelp" />
1515
</overview>
1616

1717
<recommendation>

cpp/ql/src/Critical/LateNegativeTest.qhelp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ after. Otherwise, if the value is negative then the program will have failed
1313
before performing the test.
1414
</p>
1515

16-
<include src="dataFlowWarning.qhelp" />
16+
<include src="dataFlowWarning.inc.qhelp" />
1717
</overview>
1818

1919
<recommendation>

0 commit comments

Comments
 (0)