Export comments and rspec-to-rspec links from jira
This commit is contained in:
parent
c67cba3fb2
commit
cdd7690a79
@ -17,3 +17,10 @@ METHOD MY_METHOD
|
||||
...
|
||||
ENDMETHOD.
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -13,3 +13,10 @@ public void DoSomething(){...}
|
||||
----
|
||||
public void doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -13,3 +13,10 @@ void DoSomething (void);
|
||||
----
|
||||
void doSomething (void);
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
16
rules/S100/comments-and-links.adoc
Normal file
16
rules/S100/comments-and-links.adoc
Normal file
@ -0,0 +1,16 @@
|
||||
=== Relates: RSPEC-1542
|
||||
|
||||
=== On 2013-05-20T14:29:13Z Fabrice Bellingard Wrote:
|
||||
Implementation: \http://jira.codehaus.org/browse/SONARJAVA-118
|
||||
|
||||
=== On 2013-08-02T09:05:59Z Freddy Mallet Wrote:
|
||||
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-2776
|
||||
|
||||
=== On 2014-02-12T18:08:27Z Freddy Mallet Wrote:
|
||||
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3455 for PHP
|
||||
|
||||
=== On 2018-02-06T15:30:50Z Alban Auzeill Wrote:
|
||||
COBOL use [RSPEC-1589] instead.
|
||||
|
||||
PL/I, PL/SQL, T-SQL, VB6 use [RSPEC-1542] instead.
|
||||
|
@ -27,3 +27,10 @@ void My_method_(){...} // invalid, leading and trailing underscores are reported
|
||||
== See
|
||||
|
||||
https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions[Microsoft Capitalization Conventions]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -13,3 +13,10 @@ function DoSomething(){...}
|
||||
----
|
||||
function doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ func executeAll() {
|
||||
...
|
||||
}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -22,3 +22,10 @@ Overriding methods are excluded.
|
||||
@Override
|
||||
public int Do_Something(){...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
4
rules/S100/javascript/comments-and-links.adoc
Normal file
4
rules/S100/javascript/comments-and-links.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== On 2015-05-21T14:42:13Z Linda Martin Wrote:
|
||||
Reviewed.
|
||||
|
||||
include::../comments-and-links.adoc[]
|
@ -13,3 +13,10 @@ function DoSomething(){...} // Noncompliant
|
||||
----
|
||||
function doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -28,3 +28,10 @@ function __destruct(){...}
|
||||
*/
|
||||
function myFunc(){...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ class MyClass:
|
||||
def my_method(a,b):
|
||||
...
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -31,3 +31,10 @@ C ENDSR
|
||||
endsr;
|
||||
/end-free
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ def doSomething( ) : Unit = {
|
||||
// ...
|
||||
}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
8
rules/S1000/cfamily/comments-and-links.adoc
Normal file
8
rules/S1000/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== On 2018-02-08T00:43:04Z Thomas Epperson Wrote:
|
||||
The implementation incorrectly flags unnamed namespaces in source files. The specs only refer to unnamed namespaces in HEADER files.
|
||||
|
||||
|
||||
See reported bugs in \https://sonarcloud.io/dashboard?id=uglyoldbob_decompiler%3Arestructure
|
||||
|
||||
|
||||
|
@ -50,3 +50,10 @@ void fn_b(void)
|
||||
* MISRA {cpp}:2008, 7-3-3 - There shall be no unnamed namespaces in header files.
|
||||
* https://wiki.sei.cmu.edu/confluence/x/VXs-BQ[CERT, DCL59-CPP.] - Do not define an unnamed namespace in a header file
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
11
rules/S1001/cfamily/comments-and-links.adoc
Normal file
11
rules/S1001/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,11 @@
|
||||
=== Relates: RSPEC-1003
|
||||
|
||||
=== On 2015-03-31T19:07:03Z Evgeny Mandrikov Wrote:
|
||||
\[~ann.campbell.2] implementation seems more complete (SQALE, description) than this spec.
|
||||
|
||||
=== On 2015-04-13T19:16:38Z Evgeny Mandrikov Wrote:
|
||||
\[~ann.campbell.2] Changed spelling of "using-directives" and "using-declarations" to match {cpp} language specification. Also wondering why blocker, but not active by default? Note that in implementation currently major and active.
|
||||
|
||||
=== On 2015-04-20T14:00:33Z Ann Campbell Wrote:
|
||||
in fact [~evgeny.mandrikov] I don't think I had previously edited either of those two attributes
|
||||
|
@ -24,3 +24,10 @@ using namespace NS2; // Noncompliant as there might be an ambiguity between NS1:
|
||||
|
||||
* MISRA {cpp}:2008, 7-3-4 - using-directives shall not be used.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
2
rules/S1002/cfamily/comments-and-links.adoc
Normal file
2
rules/S1002/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,2 @@
|
||||
=== Relates: RSPEC-1003
|
||||
|
@ -6,3 +6,10 @@ This rule is a strict implementation of a MISRA (Motor Industry Software Reliabi
|
||||
* MISRA {cpp} 2008, 7-3-5 - Multiple declarations for an identifier in the same namespace shall not straddle a using-declaration for that identifier.
|
||||
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
10
rules/S1003/cfamily/comments-and-links.adoc
Normal file
10
rules/S1003/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,10 @@
|
||||
=== Duplicate: RSPEC-1249
|
||||
|
||||
=== Related: RSPEC-5372
|
||||
|
||||
=== Related: RSPEC-5318
|
||||
|
||||
=== Relates: RSPEC-1001
|
||||
|
||||
=== Relates: RSPEC-1002
|
||||
|
@ -57,3 +57,10 @@ The issue only happens if the using directive is at global scope or at namespace
|
||||
* MISRA {cpp}:2008, 7-3-6 - using-directives and using-declarations (excluding class scope or function scope using-declarations) shall not be used in header files.
|
||||
* https://github.com/isocpp/CppCoreGuidelines/blob/036324/CppCoreGuidelines.md#sf7-dont-write-using-namespace-at-global-scope-in-a-header-file[{cpp} Core Guidelines SF.7] - Don’t write ``++using namespace++`` at global scope in a header file
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -7,3 +7,10 @@ include::../noncompliant.adoc[]
|
||||
* MISRA C:2004, 14.7 - A function shall have a single point of exit at the end of the function.
|
||||
* MISRA {cpp}:2008, 6-6-5 - A function shall have a single point of exit at the end of the function
|
||||
* MISRA C:2012, 15.5 - A function should have a single point of exit at the end
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
9
rules/S1005/comments-and-links.adoc
Normal file
9
rules/S1005/comments-and-links.adoc
Normal file
@ -0,0 +1,9 @@
|
||||
=== On 2014-09-05T14:19:41Z Evgeny Mandrikov Wrote:
|
||||
This rule is controversial (some people prefer early exits from functions). Also based on our experience - hard to satisfy, and so was deactivated on Dory. Thus proposal - remove from default profile.
|
||||
|
||||
=== On 2014-09-05T17:51:26Z Ann Campbell Wrote:
|
||||
\[~evgeny.mandrikov] I made that change on the 21st of August. I can't make it any off-er. :-)
|
||||
|
||||
=== On 2014-09-09T13:13:57Z Freddy Mallet Wrote:
|
||||
Ticket created on {cpp} project @Ann and @Evgeny : CPP-814
|
||||
|
@ -29,3 +29,10 @@ function func2() {
|
||||
|
||||
function func3();
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ BEGIN
|
||||
END;
|
||||
/
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -59,3 +59,10 @@ int main() {
|
||||
----
|
||||
|
||||
include::../see.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
2
rules/S1006/comments-and-links.adoc
Normal file
2
rules/S1006/comments-and-links.adoc
Normal file
@ -0,0 +1,2 @@
|
||||
=== Related: RSPEC-3719
|
||||
|
@ -78,3 +78,10 @@ public class Program
|
||||
----
|
||||
|
||||
include::../see.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ CLASS MY_CLASS DEFINITION.
|
||||
...
|
||||
ENDCLASS.
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -13,3 +13,10 @@ class myClass {}
|
||||
----
|
||||
class MyClass {}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -29,3 +29,10 @@ class Foo // Compliant
|
||||
@interface Compliant : NSObject
|
||||
@end
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
9
rules/S101/comments-and-links.adoc
Normal file
9
rules/S101/comments-and-links.adoc
Normal file
@ -0,0 +1,9 @@
|
||||
=== On 2013-05-20T12:16:47Z Fabrice Bellingard Wrote:
|
||||
Implementation: \http://jira.codehaus.org/browse/SONARJAVA-119
|
||||
|
||||
=== On 2013-10-31T16:09:00Z Freddy Mallet Wrote:
|
||||
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3228 for Flex
|
||||
|
||||
=== On 2014-02-19T15:46:02Z Freddy Mallet Wrote:
|
||||
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3495 for PHP
|
||||
|
@ -29,3 +29,10 @@ class Some_Name_XC {...} // invalid because of XC, should be Some_Name_Xc
|
||||
== See
|
||||
|
||||
* https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions[Microsoft Capitalization Conventions]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -13,3 +13,10 @@ public class myClass {...}
|
||||
----
|
||||
public class MyClass {...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -19,3 +19,10 @@ type my_struct struct {...}
|
||||
----
|
||||
type myStruct struct {...}
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -3,3 +3,10 @@ Shared coding conventions allow teams to collaborate effectively. This rule allo
|
||||
include::../noncompliant.adoc[]
|
||||
|
||||
include::../compliant.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -30,3 +30,10 @@ class my_context_manager:
|
||||
def __exit__(self, type, value, traceback):
|
||||
pass
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -17,3 +17,10 @@ class MyClass
|
||||
...
|
||||
end
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -23,3 +23,10 @@ End Class
|
||||
Class Foo ' Compliant
|
||||
End Class
|
||||
----
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
6
rules/S1011/cfamily/comments-and-links.adoc
Normal file
6
rules/S1011/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,6 @@
|
||||
=== On 2014-10-21T18:55:14Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier]
|
||||
|
||||
* for SQALE, we go with the worst-possible outcome. Since this is an "undefined behaviors" rule, Maintainability is not the best fit
|
||||
* this is likely a "bug"
|
||||
|
@ -13,3 +13,10 @@ class D: public virtual B {}; // Noncompliant, B is a virtual base
|
||||
|
||||
* MISRA {cpp}:2008, 10-1-1 - Classes should not be derived from virtual bases.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
10
rules/S1012/cfamily/comments-and-links.adoc
Normal file
10
rules/S1012/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,10 @@
|
||||
=== On 2014-10-16T13:21:54Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please:
|
||||
|
||||
* fill in the appropriate reference field(s).
|
||||
* provide a See section.
|
||||
* use double curly braces around code in the description
|
||||
* use the standard section titles
|
||||
|
||||
Also, since the description references undefined behavior, I wouldn't tie this to Maintainability, but Reliability instead.
|
||||
|
@ -16,3 +16,10 @@ class D: public virtual A {}; // Noncompliant, D is not part of a diamond-shaped
|
||||
|
||||
* MISRA {cpp}:2008, 10-1-2 - A base class shall only be declared virtual if it is used in a diamond hierarchy.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
9
rules/S1013/cfamily/comments-and-links.adoc
Normal file
9
rules/S1013/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,9 @@
|
||||
=== On 2014-10-16T13:25:29Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please:
|
||||
|
||||
* fill in the appropriate reference field(s).
|
||||
* provide a See section.
|
||||
* use double curly braces around code in the description
|
||||
|
||||
Since this is a "developer expectations" rule, I'd go with Reliability rather than maintainability, although I understand your thinking. However the rule of thumb on SQALE is that we go with the worst-case, and since unmet expectations imply that you'll get the wrong result: Reliability.
|
||||
|
@ -27,3 +27,10 @@ class C: public B1, B2, B3 {}; // Compliant, A is always virtual
|
||||
|
||||
* MISRA {cpp}:2008, 10-1-3 - An accessible base class shall not be both virtual and non-virtual in the same hierarchy.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
28
rules/S1014/cfamily/comments-and-links.adoc
Normal file
28
rules/S1014/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,28 @@
|
||||
=== Related: RSPEC-1015
|
||||
|
||||
=== Relates: RSPEC-808
|
||||
|
||||
=== On 2014-10-21T19:05:20Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] this message is written as thought it's not going to be sitting right under the duplicatively named entity...
|
||||
|
||||
=== On 2014-10-24T08:07:28Z Samuel Mercier Wrote:
|
||||
\[~ann.campbell.2] I sightly updated the message. Taking our example I think we want to flag the issue on the declarations in B2 with a reference on the declarations in B1 that are hidden.
|
||||
|
||||
So that would give :
|
||||
|
||||
"count" defined in "B2" clashes with definition in "B1" in file "file" on line 4
|
||||
|
||||
Ideally we probably want to drop the reference to the file/line and replace it with the ability to jump to that position from the issue.
|
||||
|
||||
=== On 2015-04-07T22:47:10Z Evgeny Mandrikov Wrote:
|
||||
\[~samuel.mercier] Given example violates rules of "Member name lookup" (CPP03-CPP11 10.2), exactly because it is ambiguous. So I'm wondering - is there a compiler, which will accept such code? or can this code be changed in a way that will be accepted by compiler, but still violate this rule?
|
||||
|
||||
=== On 2015-04-13T12:03:11Z Samuel Mercier Wrote:
|
||||
\[~evgeny.mandrikov] The example was taken from MISRA verbatim, and you are right, it does not compile... From there I cannot understand what is the rule about, especially since the title explicitly mention multiple inheritance.
|
||||
|
||||
|
||||
We can take the given code without implementation of method Bar in D. In that case the code compiles and we can report issues on fields count and method foo, since they are ambiguous in the hierarchy, but IMO this has very little value.
|
||||
|
||||
|
||||
I would vote to close it.
|
||||
|
@ -42,3 +42,10 @@ For the purposes of this rule, visible function identifiers that form an overloa
|
||||
|
||||
* MISRA {cpp}:2008, 10-2-1 - All accessible entity names within a multiple inheritance hierarchy should be unique.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
4
rules/S1015/cfamily/comments-and-links.adoc
Normal file
4
rules/S1015/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Related: RSPEC-1014
|
||||
|
||||
=== Relates: RSPEC-1017
|
||||
|
@ -98,3 +98,10 @@ d.f1(); // also calls B1::foo "by dominance"
|
||||
|
||||
* MISRA {cpp}:2008, 10-3-1 - There shall be no more than one definition of each virtual function on each path through the inheritance hierarchy.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
4
rules/S1016/cfamily/comments-and-links.adoc
Normal file
4
rules/S1016/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Duplicate: RSPEC-1261
|
||||
|
||||
=== Related: RSPEC-3471
|
||||
|
@ -37,3 +37,10 @@ class Derived : public Base
|
||||
|
||||
* This rule will only trigger with code compliant with {cpp}98 and {cpp}03. For code compliant with {cpp}11 and above see S3471
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
21
rules/S1017/cfamily/comments-and-links.adoc
Normal file
21
rules/S1017/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,21 @@
|
||||
=== Relates: RSPEC-832
|
||||
|
||||
=== Relates: RSPEC-833
|
||||
|
||||
=== Relates: RSPEC-927
|
||||
|
||||
=== Relates: RSPEC-1015
|
||||
|
||||
=== Relates: RSPEC-1047
|
||||
|
||||
=== On 2014-10-16T12:42:59Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please:
|
||||
|
||||
* fill in the appropriate reference field(s).
|
||||
* provide a See section.
|
||||
|
||||
For a "may not meet developer expectations" rule, I would not use Maintainability, but Reliability
|
||||
|
||||
=== On 2016-08-03T18:57:06Z Ann Campbell Wrote:
|
||||
Okay [~alban.auzeill], see what you think.
|
||||
|
@ -40,3 +40,10 @@ struct B : A {
|
||||
|
||||
* MISRA {cpp}:2008, 10-3-3 - A virtual function shall only be overridden by a pure virtual function if it is itself declared as pure virtual.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
20
rules/S1019/cfamily/comments-and-links.adoc
Normal file
20
rules/S1019/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,20 @@
|
||||
=== On 2014-10-14T18:11:13Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please correct the following
|
||||
|
||||
* Code should be quoted in the message. Also, I don't quite understand the use of "::" here.
|
||||
* Add a See section to the description listing the appropriate MISRA number
|
||||
* Fill in Applicability.
|
||||
* Make sure the appropriate MISRA C and MISRA {cpp} fields on the references tab are filled in
|
||||
* Please use the standard headings, e.g. Noncompliant Code Example instead of just Example
|
||||
|
||||
In addition, please consider clarifying the following:
|
||||
|
||||
* "final type" during construction vs the type of "the completely constructed object"
|
||||
* the Noncompliant Code Example tells us in a comment that B2 is derived, but B2 doesn't actually seem to extend anything.
|
||||
|
||||
=== On 2014-10-17T09:00:51Z Samuel Mercier Wrote:
|
||||
\[~ann.campbell.2] updated.
|
||||
|
||||
* "final type" during construction vs the type of "the completely constructed object" : this is a copy-paste of the MISRA document, so I suspect it is meaningful and correct in the {cpp} context.
|
||||
* ... but B2 doesn't actually seem to extend anything : that's correct. This example says that, if B2 is extended, then during the call of constructor B2 the dynamic type is not clearly defined.
|
||||
|
@ -40,3 +40,10 @@ public:
|
||||
|
||||
* MISRA {cpp}:2008, 12-1-1 - An object's dynamic type shall not be used from the body of its constructor or destructor.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
12
rules/S1022/cfamily/comments-and-links.adoc
Normal file
12
rules/S1022/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,12 @@
|
||||
=== On 2014-10-14T17:49:57Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please correct the following
|
||||
|
||||
* There is no message
|
||||
* Add a See section to the description listing the appropriate MISRA number
|
||||
* Fill in Applicability.
|
||||
* Make sure the appropriate MISRA C and MISRA {cpp} fields on the references tab are filled in
|
||||
|
||||
|
||||
=== On 2014-10-17T14:38:02Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] I'm tempted to tag this with 'bug'. WDYT?
|
||||
|
@ -26,3 +26,10 @@ private:
|
||||
* MISRA {cpp}:2008, 12-8-1
|
||||
* https://wiki.sei.cmu.edu/confluence/x/gXs-BQ[CERT, OOP58-CPP.] - Copy operations must not mutate the source object
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
2
rules/S1023/cfamily/comments-and-links.adoc
Normal file
2
rules/S1023/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,2 @@
|
||||
=== Related: RSPEC-3657
|
||||
|
@ -55,3 +55,10 @@ void f1( B1 & b1, B1 & b2 )
|
||||
|
||||
* MISRA {cpp}:2008, 12-8-2 - The copy assignment operator shall be declared protected or private in an abstract class.
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
5
rules/S1025/cfamily/comments-and-links.adoc
Normal file
5
rules/S1025/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,5 @@
|
||||
=== Related: RSPEC-1026
|
||||
|
||||
=== On 2014-10-21T19:12:23Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] please incorporate the text under the Noncompliant header either into the code as comments or the description. Also as a "contrary to developer expectations" I would not tie this to Maintainability/Understandability. I think I see your direction on that, but when the original developer doesn't understand what (s)he's coded, then I'd call it Reliability.
|
||||
|
@ -30,3 +30,10 @@ void f ( A const & a1 )
|
||||
|
||||
* MISRA {cpp}:2008, 14-5-2
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
2
rules/S1026/cfamily/comments-and-links.adoc
Normal file
2
rules/S1026/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,2 @@
|
||||
=== Related: RSPEC-1025
|
||||
|
@ -37,3 +37,10 @@ void f ( A const & a1, A & a2 )
|
||||
|
||||
* MISRA {cpp}:2008, 14-5-3
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
3
rules/S1027/cfamily/comments-and-links.adoc
Normal file
3
rules/S1027/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,3 @@
|
||||
=== On 2014-10-21T18:53:40Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier] would it be possible to drop the appropriate qualified-id into the message?
|
||||
|
@ -69,3 +69,10 @@ template class A<int32_t>;
|
||||
|
||||
* MISRA {cpp}:2008, 14-6-1
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
9
rules/S1028/cfamily/comments-and-links.adoc
Normal file
9
rules/S1028/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,9 @@
|
||||
=== On 2014-10-24T15:30:24Z Ann Campbell Wrote:
|
||||
\[~samuel.mercier]
|
||||
|
||||
* bug or pitfall
|
||||
* please use standard section names
|
||||
* please incorporate the text between the code samples either into the description or the code itself in the form of comments.
|
||||
|
||||
Also, the message reads as a bit disembodied. I.e. not attached to either the problem function or the template declaration
|
||||
|
@ -47,3 +47,10 @@ int main ( )
|
||||
* MISRA {cpp}:2008, 14-6-2
|
||||
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
6
rules/S1029/cfamily/comments-and-links.adoc
Normal file
6
rules/S1029/cfamily/comments-and-links.adoc
Normal file
@ -0,0 +1,6 @@
|
||||
=== Related: RSPEC-1763
|
||||
|
||||
=== Relates: RSPEC-901
|
||||
|
||||
=== Relates: RSPEC-897
|
||||
|
@ -30,3 +30,10 @@ This rule does not apply to libraries.
|
||||
|
||||
* MISRA {cpp}:2008, 14-7-1
|
||||
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
9
rules/S103/comments-and-links.adoc
Normal file
9
rules/S103/comments-and-links.adoc
Normal file
@ -0,0 +1,9 @@
|
||||
=== On 2013-05-20T14:24:19Z Fabrice Bellingard Wrote:
|
||||
Implementation: \http://jira.codehaus.org/browse/SONARJAVA-120
|
||||
|
||||
=== On 2014-02-12T21:44:45Z Freddy Mallet Wrote:
|
||||
Is implemented by \http://jira.codehaus.org/browse/SONARPLUGINS-3466 for PHP
|
||||
|
||||
=== On 2018-02-06T15:27:24Z Alban Auzeill Wrote:
|
||||
RPG use [RSPEC-2031] instead.
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
14
rules/S103/go/comments-and-links.adoc
Normal file
14
rules/S103/go/comments-and-links.adoc
Normal file
@ -0,0 +1,14 @@
|
||||
=== On 2018-04-12T15:58:09Z Alexandre Gigleux Wrote:
|
||||
According to \https://golang.org/doc/effective_go.html ...
|
||||
|
||||
|
||||
____
|
||||
Line length
|
||||
|
||||
Go has no line length limit. Don't worry about overflowing a punched card. If a line feels too long, wrap it and indent with an extra tab.
|
||||
|
||||
____
|
||||
|
||||
{empty}... but still it's good to enforce a convention.
|
||||
|
||||
include::../comments-and-links.adoc[]
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
@ -1 +1,8 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::rspecator-view[]
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
||||
include::../comments-and-links.adoc[]
|
||||
endif::rspecator-view[]
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user