Comments (6)
The underlying cause appears to be that C style comments, /*
, are not covered here: https://github.com/ament/ament_lint/blob/master/ament_copyright/ament_copyright/__init__.py#L314
This the copyright block is not considered a comment and not scanned for the copyright.
from ament_lint.
In order to keep the logic of this package simple it does not detect block comments. I don't think we should increase complexity for that but update the existing code to use non-block comments.
from ament_lint.
We could make it the standard for all our new code. But we're already preferring the block quotes greping our current code base we have 36 instances of c-style copyright blocks and 0 instances of c++ style copyright blocks.
(r2) tfoote@yeti:~/work/r2/ros2_ws$ grep -rI Copyright * > /tmp/copyright
(r2) tfoote@yeti:~/work/r2/ros2_ws$ cat /tmp/copyright | grep "\*" | wc -l
36
(r2) tfoote@yeti:~/work/r2/ros2_ws$ cat /tmp/copyright | grep "//" | wc -l
0
Also important is that the c-style copyright and licenses has been the default template used throughout the ROS ecosystem already. Not fixing this would force anyone to change the license block on packages being ported. It's both a pain for anyone making the port as well as making a mess for checking licensing.
And lastly it should be true that if anyone embeds code it should be detected without modifications.
It will make the logic much simpler in this script, but that's making this tool not useful in many of our use cases.
from ament_lint.
We decided in today's meeting to not support block comments for now.
Therefore I would propose to close the ticket.
from ament_lint.
Yeah, we can close it. It would be good to add comment to this effect in the documentation so people know it won't expect it to detect on c-style comments.
from ament_lint.
The PR extending ament_copyright
to support licenses will contain a note in the documentation that block comments are not supported: https://github.com/ament/ament_lint/pull/15/files#diff-156d8d387088e2de200fc4c6f5bec6ecR47
from ament_lint.
Related Issues (20)
- `ament_clang_format` and `colcon test` HOT 4
- [ament_cppcheck] provide libraries
- Update humble ament_pep257 package HOT 5
- Please tag a new release of `ament_lint` for `foxy` HOT 2
- Ament-flake8 attributeError Humble HOT 4
- Support for other filetypes for ament_copyright HOT 2
- ament_uncrustify is incompatible with uncrustify >= 0.75 HOT 1
- ament_pep257 crashes during xunit generation when non-pep257 errors occur
- What is the general release strategy? HOT 1
- ament_xmllint stuck when no internet
- Feature Rquest: ament_cmake_clang_tidy, specify --header-filter and --jobs options to ament_clang_tidy
- (ament_xmllint) add extension argument
- ament_cmake_pep257, ament_cmake_lint_cmake, ament_cmake_xmllint ignores value of AMENT_LINT_AUTO_FILE_EXCLUDE HOT 1
- ament_flake8 fails with flake8>=6.0.0 HOT 5
- ament_lint_auto finds recursive test dependencies causing downstream packages to inherit conflicting linters
- ament_copyright does not recognize REUSE-compliant copyright headers
- TypeError on debian11 HOT 1
- EXCLUDE argument parsed differently in different linters HOT 2
- BSD 3 license (and maybe others) require a copyright notice at the top of the license file HOT 2
- ament_lint_cmake doesn't display reasons for error when run through pre-commit HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ament_lint.