Skip to content

Commit 60da72d

Browse files
authored
Merge pull request #1723 from gewarren/gewarren-rule-sets
Updated rule sets topics
2 parents 276afef + cf60650 commit 60da72d

7 files changed

+118
-171
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@
9797
"redirect_url": "/visualstudio/code-quality/code-analysis-for-c-cpp-overview",
9898
"redirect_document_id": false
9999
},
100+
{
101+
"source_path": "docs/code-quality/code-analysis-rule-set-reference.md",
102+
"redirect_url": "/visualstudio/code-quality/managed-minimun-rules-rule-set-for-managed-code",
103+
"redirect_document_id": false
104+
},
100105
{
101106
"source_path": "docs/code-quality/creating-and-using-code-analysis-check-in-policies.md",
102107
"redirect_url": "/visualstudio/code-quality/how-to-create-or-update-standard-code-analysis-check-in-policies",

docs/code-quality/TOC.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@
2424
### [Anonymous Methods and Code Analysis](anonymous-methods-and-code-analysis.md)
2525
### [Create a Work Item for a Managed Code Defect](how-to-create-a-work-item-for-a-managed-code-defect.md)
2626
## Code Analysis for C/C++
27-
### [Use Rule Sets to Specify the C++ Rules to Run](using-rule-sets-to-specify-the-cpp-rules-to-run.md)
2827
### [Use the C++ Core Guidelines checkers](using-the-cpp-core-guidelines-checkers.md)
29-
### [Set Code Analysis Properties for C/C++ Projects](how-to-set-code-analysis-properties-for-c-cpp-projects.md)
30-
### [Use SAL Annotations to Reduce C/C++ Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
28+
### [Set Code Analysis Properties](how-to-set-code-analysis-properties-for-c-cpp-projects.md)
29+
### [Use SAL Annotations to Reduce Code Defects](using-sal-annotations-to-reduce-c-cpp-code-defects.md)
3130
#### [Understand SAL](understanding-sal.md)
3231
#### [Annotate Function Parameters and Return Values](annotating-function-parameters-and-return-values.md)
3332
#### [Annotate Function Behavior](annotating-function-behavior.md)
@@ -38,27 +37,14 @@
3837
#### [Best Practices and Examples (SAL)](best-practices-and-examples-sal.md)
3938
### [Specify Additional Code Information by Using __analysis_assume](how-to-specify-additional-code-information-by-using-analysis-assume.md)
4039
## [Use Rule Sets to Group Code Analysis Rules](using-rule-sets-to-group-code-analysis-rules.md)
41-
### [Configure Code Analysis for a Managed Code Project](how-to-configure-code-analysis-for-a-managed-code-project.md)
42-
### [Configure Code Analysis for an ASP.NET Web Application](how-to-configure-code-analysis-for-an-aspnet-web-application.md)
43-
### [Synchronize Code Project Rule Sets with Team Project Check-in Policy](how-to-synchronize-code-project-rule-sets-with-team-project-check-in-policy.md)
44-
### [Specify Managed Code Rule Sets for Multiple Projects in a Solution](how-to-specify-managed-code-rule-sets-for-multiple-projects-in-a-solution.md)
45-
### [Create Custom Code Analysis Rule Sets](creating-custom-code-analysis-rule-sets.md)
40+
### [Use Rule Sets for Managed Code](how-to-configure-code-analysis-for-a-managed-code-project.md)
41+
#### [Configure Code Analysis for an ASP.NET Web Application](how-to-configure-code-analysis-for-an-aspnet-web-application.md)
42+
#### [Specify Rule Sets for Multiple Projects](how-to-specify-managed-code-rule-sets-for-multiple-projects-in-a-solution.md)
43+
### [Use Rule Sets for C++ Code](using-rule-sets-to-specify-the-cpp-rules-to-run.md)
44+
### [Synchronize Project Rule Sets with Team Project Check-in Policy](how-to-synchronize-code-project-rule-sets-with-team-project-check-in-policy.md)
45+
### [Create Custom Rule Sets](creating-custom-code-analysis-rule-sets.md)
4646
#### [Create a Custom Rule Set](how-to-create-a-custom-rule-set.md)
47-
#### [Use the Code Analysis Rule Set Editor](working-in-the-code-analysis-rule-set-editor.md)
48-
### [Code analysis rule set reference](code-analysis-rule-set-reference.md)
49-
#### [All Rules rule set](all-rules-rule-set.md)
50-
#### [Basic Correctness Rules rule set for managed code](basic-correctness-rules-rule-set-for-managed-code.md)
51-
#### [Basic Design Guideline Rules rule set for managed code](basic-design-guideline-rules-rule-set-for-managed-code.md)
52-
#### [Extended Correctness Rules rule set for managed code](extended-correctness-rules-rule-set-for-managed-code.md)
53-
#### [Extended Design Guidelines Rules rule set for managed code](extended-design-guidelines-rules-rule-set-for-managed-code.md)
54-
#### [Globalization Rules rule set for managed code](globalization-rules-rule-set-for-managed-code.md)
55-
#### [Managed Minimun Rules rule set for managed code](managed-minimun-rules-rule-set-for-managed-code.md)
56-
#### [Managed Recommended Rules rule set for managed code](managed-recommended-rules-rule-set-for-managed-code.md)
57-
#### [Mixed Minimum Rules rule set](mixed-minimum-rules-rule-set.md)
58-
#### [Mixed Recommended Rules rule set](mixed-recommended-rules-rule-set.md)
59-
#### [Native Minimum Rules rule set](native-minimum-rules-rule-set.md)
60-
#### [Native Recommended Rules rule set](native-recommended-rules-rule-set.md)
61-
#### [Security Rules rule set for managed code](security-rules-rule-set-for-managed-code.md)
47+
#### [Use the Rule Set Editor](working-in-the-code-analysis-rule-set-editor.md)
6248
## [Create Code Analysis Check-in Policies](how-to-create-or-update-standard-code-analysis-check-in-policies.md)
6349
### [Implement Custom Code Analysis Check-in Policies for Managed Code](implementing-custom-code-analysis-check-in-policies-for-managed-code.md)
6450
### [Enforce Maintainable Code](how-to-enforce-maintainable-code-with-a-code-analysis-check-in-policy.md)
@@ -67,6 +53,20 @@
6753
### [Generate Code Metrics Data](how-to-generate-code-metrics-data.md)
6854
### [Work with Code Metrics Data](working-with-code-metrics-data.md)
6955
# Reference
56+
## Rule sets
57+
### [All Rules rule set](all-rules-rule-set.md)
58+
### [Basic Correctness Rules rule set for managed code](basic-correctness-rules-rule-set-for-managed-code.md)
59+
### [Basic Design Guideline Rules rule set for managed code](basic-design-guideline-rules-rule-set-for-managed-code.md)
60+
### [Extended Correctness Rules rule set for managed code](extended-correctness-rules-rule-set-for-managed-code.md)
61+
### [Extended Design Guidelines Rules rule set for managed code](extended-design-guidelines-rules-rule-set-for-managed-code.md)
62+
### [Globalization Rules rule set for managed code](globalization-rules-rule-set-for-managed-code.md)
63+
### [Managed Minimun Rules rule set for managed code](managed-minimun-rules-rule-set-for-managed-code.md)
64+
### [Managed Recommended Rules rule set for managed code](managed-recommended-rules-rule-set-for-managed-code.md)
65+
### [Mixed Minimum Rules rule set](mixed-minimum-rules-rule-set.md)
66+
### [Mixed Recommended Rules rule set](mixed-recommended-rules-rule-set.md)
67+
### [Native Minimum Rules rule set](native-minimum-rules-rule-set.md)
68+
### [Native Recommended Rules rule set](native-recommended-rules-rule-set.md)
69+
### [Security Rules rule set for managed code](security-rules-rule-set-for-managed-code.md)
7070
## [Code Analysis for Managed Code Warnings](code-analysis-for-managed-code-warnings.md)
7171
### [Code Analysis Warnings for Managed Code by CheckId](code-analysis-warnings-for-managed-code-by-checkid.md)
7272
### [Cryptography Warnings](cryptography-warnings.md)

docs/code-quality/code-analysis-rule-set-reference.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/code-quality/fxcopcmd-errors.md

Lines changed: 42 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,52 @@
11
---
2-
title: "FxCopCmd Errors | Microsoft Docs"
3-
ms.custom: ""
2+
title: "FxCopCmd errors | Microsoft Docs"
43
ms.date: "10/19/2016"
5-
ms.reviewer: ""
6-
ms.suite: ""
7-
ms.technology:
8-
- "vs-ide-code-analysis"
9-
ms.tgt_pltfrm: ""
4+
ms.technology: vs-ide-code-analysis
105
ms.topic: "article"
11-
helpviewer_keywords:
6+
helpviewer_keywords:
127
- "FxCopCmd errors"
138
ms.assetid: bb614ed0-1b7c-4b56-99ae-da50ef6cfef9
14-
caps.latest.revision: 12
159
ms.author: "gewarren"
1610
author: "gewarren"
1711
manager: ghogen
18-
ms.workload:
12+
ms.workload:
1913
- "multiple"
2014
---
21-
# FxCopCmd Errors
22-
FxCopCmd does not consider all errors to be fatal. If FxCopCmd has sufficient information to perform a partial analysis, it performs the analysis and reports errors that occurred. The error code, which is a 32-bit integer, contains a bitwise combination of numeric values that correspond to errors.
23-
24-
The following table describes the error codes returned by FxCopCmd:
25-
26-
|Error|Numeric value|
27-
|-----------|-------------------|
28-
|No errors|0x0|
29-
|Analysis error|0x1|
30-
|Rule exceptions|0x2|
31-
|Project load error|0x4|
32-
|Assembly load error|0x8|
33-
|Rule library load error|0x10|
34-
|Import report load error|0x20|
35-
|Output error|0x40|
36-
|Command line switch error|0x80|
37-
|Initialization error|0x100|
38-
|Assembly references error|0x200|
39-
|BuildBreakingMessage|0x400|
40-
|Unknown error|0x1000000|
41-
42-
The Analysis error is returned for fatal errors. It indicates that the analysis could not be completed. When applicable, the error code also contains the underlying cause of the fatal error. The following conditions generate fatal errors:
43-
44-
- The analysis could not be performed caused by insufficient input.
45-
46-
- The analysis threw an exception that is not handled by FxCopCmd.
47-
48-
- The specified project file could not be found or is corrupted.
49-
50-
- The output option was not specified or the file could not be written.
51-
52-
> [!NOTE]
53-
> The FxCopCmd return code "Assembly references error" 0x200 by itself is a warning rather than an error. This return code indicates that missing indirect references were found but that FxCopCmd was able to handle them. It is a warning that there is a possibility that some analysis results might have been compromised. Consider "Assembly references error" return code as an error when it is combined with any other return code.
54-
55-
## See Also
56-
[Code Analysis Application Errors](../code-quality/code-analysis-application-errors.md)
15+
# FxCopCmd tool errors
16+
17+
FxCopCmd does not consider all errors to be fatal. If FxCopCmd has sufficient information to perform a partial analysis, it performs the analysis and reports errors that occurred. The error code, which is a 32-bit integer, contains a bitwise combination of numeric values that correspond to errors.
18+
19+
The following table describes the error codes returned by FxCopCmd:
20+
21+
|Error|Numeric value|
22+
|-----------|-------------------|
23+
|No errors|0x0|
24+
|Analysis error|0x1|
25+
|Rule exceptions|0x2|
26+
|Project load error|0x4|
27+
|Assembly load error|0x8|
28+
|Rule library load error|0x10|
29+
|Import report load error|0x20|
30+
|Output error|0x40|
31+
|Command line switch error|0x80|
32+
|Initialization error|0x100|
33+
|Assembly references error|0x200|
34+
|BuildBreakingMessage|0x400|
35+
|Unknown error|0x1000000|
36+
37+
**Analysis error** is returned for fatal errors. It indicates that the analysis could not be completed. When applicable, the error code also contains the underlying cause of the fatal error. The following conditions generate fatal errors:
38+
39+
- The analysis could not be performed because of insufficient input.
40+
41+
- The analysis threw an exception that is not handled by FxCopCmd.
42+
43+
- The specified project file could not be found or is corrupted.
44+
45+
- The output option was not specified or the file could not be written.
46+
47+
> [!NOTE]
48+
> The FxCopCmd return code **Assembly references error** 0x200 by itself is a warning rather than an error. This return code indicates that there are missing indirect references, but that FxCopCmd was able to handle them. The warning means there's a possibility that some analysis results might have been compromised. Treat **Assembly references error** as an error when it is combined with any other return code.
49+
50+
## See also
51+
52+
- [Code Analysis Application Errors](../code-quality/code-analysis-application-errors.md)

0 commit comments

Comments
 (0)