Skip to content

Commit 265d5f7

Browse files
JasperCraeghsJasperCraeghs
committed
Change line endings from CRLF to LF
1 parent d023bb1 commit 265d5f7

9 files changed

+230
-233
lines changed

‎CONTRIBUTING.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
Contribution Guide
2-
==================
3-
Anyone is more than welcome to contribute to the development of warnings-plugin,
4-
no matter of your prorgamming skill level. It is reviewers obligation to help bring your
5-
contribution to our desired quality level and you should do your best to help reviewer
6-
understand your decisions. Standard GitHub flow is used https://guides.github.com/introduction/flow/
7-
to start Pull Requests, which are then merged. We also prefer to make a Work In Progress
8-
Merge request once you starting your work just in case someone else is not working on the
9-
same issue.
10-
11-
Getting Started
12-
===============
13-
There should always be few issues opened for new features, otherwise you are also
14-
more than welcome to create some on your own suggestions. The `help wanted` label
15-
indicates that it is easy enough task for anyone to start, so go and pick up the
16-
feature you feel most excited by and start implementing it.
17-
18-
Quality of Contribution
19-
-----------------------
20-
All new contributions need to be properly tested. We are not targeting some coverage
21-
percentage, but rather focus on regression testing to confirm expected functionality
22-
and border cases. This will help us keep existing features even after years of constant
23-
development and it helps fixing regression bugs.
24-
25-
Documentation
26-
-------------
27-
Basic documentation is expected, but every bit of detail you can include will help in
28-
the future. It might look obvious, but it will also help person reviewing the code to
29-
correctly understand the intended functionality, so that he can focus more on implementation
30-
aspect.
31-
32-
Code Review
33-
-----------
34-
Anyone is more than welcome to check open Pull requests and make a code review. Everyone
35-
benefits from fresh eyes looking at new features or bug fixes and it also improves
36-
coding skills of all included. Remember to act politely. Since some people might not be
37-
frequent contributors to various repositories, do not intimidate them, but rather
38-
help them improve. We are all learning.
39-
40-
41-
Reporting Issues or Requesting a New Feature
42-
============================================
43-
Please open a new Issue if you have any problems with the usage plugin. We will be happy
44-
to fix them as soon as possible. If you want some feature to be included, but do not know
45-
where to start, you should also open an Issue with label `enhancement` and we
46-
can implement it when we have time and it fits in our view.
1+
Contribution Guide
2+
==================
3+
Anyone is more than welcome to contribute to the development of warnings-plugin,
4+
no matter of your prorgamming skill level. It is reviewers obligation to help bring your
5+
contribution to our desired quality level and you should do your best to help reviewer
6+
understand your decisions. Standard GitHub flow is used https://guides.github.com/introduction/flow/
7+
to start Pull Requests, which are then merged. We also prefer to make a Work In Progress
8+
Merge request once you starting your work just in case someone else is not working on the
9+
same issue.
10+
11+
Getting Started
12+
===============
13+
There should always be few issues opened for new features, otherwise you are also
14+
more than welcome to create some on your own suggestions. The `help wanted` label
15+
indicates that it is easy enough task for anyone to start, so go and pick up the
16+
feature you feel most excited by and start implementing it.
17+
18+
Quality of Contribution
19+
-----------------------
20+
All new contributions need to be properly tested. We are not targeting some coverage
21+
percentage, but rather focus on regression testing to confirm expected functionality
22+
and border cases. This will help us keep existing features even after years of constant
23+
development and it helps fixing regression bugs.
24+
25+
Documentation
26+
-------------
27+
Basic documentation is expected, but every bit of detail you can include will help in
28+
the future. It might look obvious, but it will also help person reviewing the code to
29+
correctly understand the intended functionality, so that he can focus more on implementation
30+
aspect.
31+
32+
Code Review
33+
-----------
34+
Anyone is more than welcome to check open Pull requests and make a code review. Everyone
35+
benefits from fresh eyes looking at new features or bug fixes and it also improves
36+
coding skills of all included. Remember to act politely. Since some people might not be
37+
frequent contributors to various repositories, do not intimidate them, but rather
38+
help them improve. We are all learning.
39+
40+
41+
Reporting Issues or Requesting a New Feature
42+
============================================
43+
Please open a new Issue if you have any problems with the usage plugin. We will be happy
44+
to fix them as soon as possible. If you want some feature to be included, but do not know
45+
where to start, you should also open an Issue with label `enhancement` and we
46+
can implement it when we have time and it fits in our view.

‎docs/authors.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
=======
2-
Authors
3-
=======
4-
5-
Melexis Warnings plugin is mainly maintained by:
6-
7-
- Bavo Van Achte
8-
- Crt Mori
9-
- Stein Heselmans
10-
- Jasper Craeghs
1+
=======
2+
Authors
3+
=======
4+
5+
Melexis Warnings plugin is mainly maintained by:
6+
7+
- Bavo Van Achte
8+
- Crt Mori
9+
- Stein Heselmans
10+
- Jasper Craeghs

‎docs/index.rst

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
========
2-
Contents
3-
========
4-
5-
.. toctree::
6-
:maxdepth: 2
7-
8-
readme
9-
installation
10-
design
11-
contributing
12-
authors
13-
14-
Indices and Tables
15-
==================
16-
17-
* :ref:`genindex`
18-
* :ref:`modindex`
19-
* :ref:`search`
1+
========
2+
Contents
3+
========
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
8+
readme
9+
installation
10+
design
11+
contributing
12+
authors
13+
14+
Indices and Tables
15+
==================
16+
17+
* :ref:`genindex`
18+
* :ref:`modindex`
19+
* :ref:`search`

‎docs/installation.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
==================
2-
Installation Guide
3-
==================
4-
5-
Melexis Warnings plugin is available as a package on PyPI. Once installed, it
6-
offers direct command line invocation (no need to run python infront).
7-
Installation is as simple as:
8-
9-
.. code-block:: bash
10-
11-
# Python3
12-
pip3 install mlx.warnings
13-
14-
So far we are not aware of any problems with installation of the plugin, but in
15-
case you have any please open an Issue.
1+
==================
2+
Installation Guide
3+
==================
4+
5+
Melexis Warnings plugin is available as a package on PyPI. Once installed, it
6+
offers direct command line invocation (no need to run python infront).
7+
Installation is as simple as:
8+
9+
.. code-block:: bash
10+
11+
# Python3
12+
pip3 install mlx.warnings
13+
14+
So far we are not aware of any problems with installation of the plugin, but in
15+
case you have any please open an Issue.

‎tests/test_in/coverity_single_defect.txt

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
/src/somefile.c:80: CID 113396 (#1 of 2): Coding standard violation (MISRA C-2012 Rule 10.1): Unclassified, Unspecified, Undecided, owner is nobody, first detected on 2017-07-27.
2-
/src/somefile.c:82: CID 113396 (#2 of 2): Coding standard violation (MISRA C-2012 Rule 10.1): Unclassified, Unspecified, Undecided, owner is nobody, first detected on 2017-07-27.
3-
src/something/src/somefile.c:82: 1. misra_violation: Essential type of the left hand operand "0U" (unsigned) is not the same as that of the right operand "1U"(signed).
4-
1+
/src/somefile.c:80: CID 113396 (#1 of 2): Coding standard violation (MISRA C-2012 Rule 10.1): Unclassified, Unspecified, Undecided, owner is nobody, first detected on 2017-07-27.
2+
/src/somefile.c:82: CID 113396 (#2 of 2): Coding standard violation (MISRA C-2012 Rule 10.1): Unclassified, Unspecified, Undecided, owner is nobody, first detected on 2017-07-27.
3+
src/something/src/somefile.c:82: 1. misra_violation: Essential type of the left hand operand "0U" (unsigned) is not the same as that of the right operand "1U"(signed).

‎tests/test_in/doxygen_warnings.txt

+52-52
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
1-
Notice: Output directory `doc/doxygen/framework' does not exist. I have created it for you.
2-
/home/user/myproject/component/odesolver/CentralDifferenceSolver.cpp:171: Warning: reached end of file while inside a dot block!
3-
The command that should end the block seems to be missing!
4-
5-
/home/user/myproject/helper/LCPcalc.cpp:479: Warning: the name `lcp_lexicolemke.c' supplied as the second argument in the \file statement is not an input file
6-
/home/user/myproject/core/componentmodel/behavior/BaseController.cpp:65: Warning: documented function `sofa::core::componentmodel::behavior::BaseController::BaseController' was not declared or defined.
7-
/home/user/myproject/core/componentmodel/behavior/BaseController.cpp:72: Warning: no matching class member found for
8-
void sofa::core::componentmodel::behavior::BaseController::handleEvent(core::objectmodel::Event *event)
9-
10-
/home/user/myproject/defaulttype/RigidTypes.h:699: Warning: no uniquely matching class member found for
11-
template <>
12-
const char * sofa::defaulttype::Rigid3dTypes::Name()
13-
/home/user/myproject/defaulttype/RigidTypes.h:1351: Warning: no matching file member found for
14-
defaulttype::RigidDeriv< 3, double > sofa::core::componentmodel::behavior::inertiaForce< defaulttype::RigidCoord< 3, double >, defaulttype::RigidDeriv< 3, double >, objectmodel::BaseContext::Vec3, defaulttype::RigidMass< 3, double >, objectmodel::BaseContext::SpatialVector >(const sofa::defaulttype::SolidTypes::SpatialVector &vframe, const objectmodel::BaseContext::Vec3 &aframe, const defaulttype::RigidMass< 3, double > &mass, const defaulttype::RigidCoord< 3, double > &x, const defaulttype::RigidDeriv< 3, double > &v)
15-
Possible candidates:
16-
Deriv inertiaForce(const SV &, const Vec &, const M &, const Coord &, const Deriv &)
17-
/home/user/myproject/defaulttype/SolidTypes.inl:569: Warning: no uniquely matching class member found for
18-
template < R >
19-
SolidTypes< R >::Vec sofa::defaulttype::SolidTypes< R >::mult(const typename sofa::defaulttype::Mat< 3, 3, Real > &m, const typename SolidTypes< R >::Vec &v)
20-
Possible candidates:
21-
static Vec sofa::defaulttype::SolidTypes< R >::mult(const Mat &m, const Vec &v) at line 404 of file /home/user/myprojeOdeSolverct/defaulttype/SolidTypes.h
22-
/home/user/myproject/helper/DualQuat.inl:227: Warning: no uniquely matching class member found for
23-
template < Real >
24-
DualQuat< Real >::Vec sofa::helper::DualQuat< Real >::transform(const typename sofa::defaulttype::Vec< 3, Real > &vec)
25-
Possible candidates:
26-
Vec sofa::helper::DualQuat< Real >::transform(const Vec &vec) at line 73 of file /home/user/myproject/helper/DualQuat.h
27-
28-
29-
/home/user/myproject/helper/LCPcalc.cpp:496: Warning: no matching file member found for
30-
void sofa::helper::lcp_lexicolemke(int *nn, double *vec, double *q, double *zlem, double *wlem, int *info, int *iparamLCP, double *dparamLCP)
31-
Possible candidates:
32-
int lcp_lexicolemke(int dim, double *q, double **M, double *res)
33-
int lcp_lexicolemke(int dim, double *q, double **M, double **A, double *res)
34-
/home/user/myproject/core/componentmodel/topology/BaseTopology.h:163: Warning: Found unknown command `\notify'
35-
/home/user/myproject/core/componentmodel/behavior/Mass.h:172: Warning: argument 'sv' of command @param is not found in the argument list of sofa::core::componentmodel::behavior::inertiaForce(const SV &, const Vec &, const M &, const Coord &, const Deriv &)
36-
/home/user/myproject/core/componentmodel/behavior/BaseForceField.h:97: Warning: The following parameters of sofa::core::componentmodel::behavior::BaseForceField::addMBKdx(double mFactor, double bFactor, double kFactor) are not documented:
37-
parameter 'mFactor'
38-
parameter 'bFactor'
39-
parameter 'kFactor'
40-
/home/user/myproject/core/componentmodel/behavior/BaseLMConstraint.h:104: Warning: The following parameters of sofa::core::componentmodel::behavior::BaseLMConstraint::ConstraintGroup::addConstraint(unsigned int i0, SReal c) are not documented:
41-
parameter 'i0'
42-
/home/user/myproject/core/componentmodel/behavior/BaseMass.h:98: Warning: explicit link request to 'index' could not be resolved
43-
<unknown>:1: Detected potential recursive class relation between class sofa::core::componentmodel::collision::Contact::Factory and base class Factory< std::string, Contact, std::pair< std::pair< core::CollisionModel *, core::CollisionModel * >, Intersection * > >!
44-
45-
/home/user/myproject/core/componentmodel/behavior/OdeSolver.h:96: Warning: Found unknown command `\TODO'
46-
<unknown>:-1: Warning: Found unknown command `\TODO'
47-
<unknown>:1: Warning: Found unknown command `\TODO'
48-
/home/user/myproject/helper/SimpleTimer.h:19: Error: Unexpected character `"'
49-
<v_peq>:1: Warning: The following parameters of sofa::component::odesolver::EulerKaapiSolver::v_peq(VecId v, VecId a, double f) are not documented:
50-
parameter 'v'
51-
parameter 'a'
52-
error: Could not read image `/home/user/myproject/html/struct_foo_graph.png' generated by dot!
1+
Notice: Output directory `doc/doxygen/framework' does not exist. I have created it for you.
2+
/home/user/myproject/component/odesolver/CentralDifferenceSolver.cpp:171: Warning: reached end of file while inside a dot block!
3+
The command that should end the block seems to be missing!
4+
5+
/home/user/myproject/helper/LCPcalc.cpp:479: Warning: the name `lcp_lexicolemke.c' supplied as the second argument in the \file statement is not an input file
6+
/home/user/myproject/core/componentmodel/behavior/BaseController.cpp:65: Warning: documented function `sofa::core::componentmodel::behavior::BaseController::BaseController' was not declared or defined.
7+
/home/user/myproject/core/componentmodel/behavior/BaseController.cpp:72: Warning: no matching class member found for
8+
void sofa::core::componentmodel::behavior::BaseController::handleEvent(core::objectmodel::Event *event)
9+
10+
/home/user/myproject/defaulttype/RigidTypes.h:699: Warning: no uniquely matching class member found for
11+
template <>
12+
const char * sofa::defaulttype::Rigid3dTypes::Name()
13+
/home/user/myproject/defaulttype/RigidTypes.h:1351: Warning: no matching file member found for
14+
defaulttype::RigidDeriv< 3, double > sofa::core::componentmodel::behavior::inertiaForce< defaulttype::RigidCoord< 3, double >, defaulttype::RigidDeriv< 3, double >, objectmodel::BaseContext::Vec3, defaulttype::RigidMass< 3, double >, objectmodel::BaseContext::SpatialVector >(const sofa::defaulttype::SolidTypes::SpatialVector &vframe, const objectmodel::BaseContext::Vec3 &aframe, const defaulttype::RigidMass< 3, double > &mass, const defaulttype::RigidCoord< 3, double > &x, const defaulttype::RigidDeriv< 3, double > &v)
15+
Possible candidates:
16+
Deriv inertiaForce(const SV &, const Vec &, const M &, const Coord &, const Deriv &)
17+
/home/user/myproject/defaulttype/SolidTypes.inl:569: Warning: no uniquely matching class member found for
18+
template < R >
19+
SolidTypes< R >::Vec sofa::defaulttype::SolidTypes< R >::mult(const typename sofa::defaulttype::Mat< 3, 3, Real > &m, const typename SolidTypes< R >::Vec &v)
20+
Possible candidates:
21+
static Vec sofa::defaulttype::SolidTypes< R >::mult(const Mat &m, const Vec &v) at line 404 of file /home/user/myprojeOdeSolverct/defaulttype/SolidTypes.h
22+
/home/user/myproject/helper/DualQuat.inl:227: Warning: no uniquely matching class member found for
23+
template < Real >
24+
DualQuat< Real >::Vec sofa::helper::DualQuat< Real >::transform(const typename sofa::defaulttype::Vec< 3, Real > &vec)
25+
Possible candidates:
26+
Vec sofa::helper::DualQuat< Real >::transform(const Vec &vec) at line 73 of file /home/user/myproject/helper/DualQuat.h
27+
28+
29+
/home/user/myproject/helper/LCPcalc.cpp:496: Warning: no matching file member found for
30+
void sofa::helper::lcp_lexicolemke(int *nn, double *vec, double *q, double *zlem, double *wlem, int *info, int *iparamLCP, double *dparamLCP)
31+
Possible candidates:
32+
int lcp_lexicolemke(int dim, double *q, double **M, double *res)
33+
int lcp_lexicolemke(int dim, double *q, double **M, double **A, double *res)
34+
/home/user/myproject/core/componentmodel/topology/BaseTopology.h:163: Warning: Found unknown command `\notify'
35+
/home/user/myproject/core/componentmodel/behavior/Mass.h:172: Warning: argument 'sv' of command @param is not found in the argument list of sofa::core::componentmodel::behavior::inertiaForce(const SV &, const Vec &, const M &, const Coord &, const Deriv &)
36+
/home/user/myproject/core/componentmodel/behavior/BaseForceField.h:97: Warning: The following parameters of sofa::core::componentmodel::behavior::BaseForceField::addMBKdx(double mFactor, double bFactor, double kFactor) are not documented:
37+
parameter 'mFactor'
38+
parameter 'bFactor'
39+
parameter 'kFactor'
40+
/home/user/myproject/core/componentmodel/behavior/BaseLMConstraint.h:104: Warning: The following parameters of sofa::core::componentmodel::behavior::BaseLMConstraint::ConstraintGroup::addConstraint(unsigned int i0, SReal c) are not documented:
41+
parameter 'i0'
42+
/home/user/myproject/core/componentmodel/behavior/BaseMass.h:98: Warning: explicit link request to 'index' could not be resolved
43+
<unknown>:1: Detected potential recursive class relation between class sofa::core::componentmodel::collision::Contact::Factory and base class Factory< std::string, Contact, std::pair< std::pair< core::CollisionModel *, core::CollisionModel * >, Intersection * > >!
44+
45+
/home/user/myproject/core/componentmodel/behavior/OdeSolver.h:96: Warning: Found unknown command `\TODO'
46+
<unknown>:-1: Warning: Found unknown command `\TODO'
47+
<unknown>:1: Warning: Found unknown command `\TODO'
48+
/home/user/myproject/helper/SimpleTimer.h:19: Error: Unexpected character `"'
49+
<v_peq>:1: Warning: The following parameters of sofa::component::odesolver::EulerKaapiSolver::v_peq(VecId v, VecId a, double f) are not documented:
50+
parameter 'v'
51+
parameter 'a'
52+
error: Could not read image `/home/user/myproject/html/struct_foo_graph.png' generated by dot!

‎tests/test_in/sphinx_double_warning.txt

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
/home/bljah/test/index.rst:5: WARNING: toctree contains reference to nonexisting document u'installation'
2-
/home/bljah/test/index.rst:None: WARNING: toctree contains reference to nonexisting document u'installation'
3-
1+
/home/bljah/test/index.rst:5: WARNING: toctree contains reference to nonexisting document u'installation'
2+
/home/bljah/test/index.rst:None: WARNING: toctree contains reference to nonexisting document u'installation'

‎tests/test_in/sphinx_single_warning.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
/home/bljah/test/index.rst:5: WARNING: toctree contains reference to nonexisting document u'installation'
2-
1+
/home/bljah/test/index.rst:5: WARNING: toctree contains reference to nonexisting document u'installation'

0 commit comments

Comments
 (0)