Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add package.xml checks #25

Open
cottsay opened this issue Apr 16, 2014 · 3 comments
Open

Add package.xml checks #25

cottsay opened this issue Apr 16, 2014 · 3 comments

Comments

@cottsay
Copy link
Member

cottsay commented Apr 16, 2014

It might be useful to add basic checks on the package.xml for a package.

Particularly, I've seen a few packages use <license></license> which doesn't cause any errors, but makes RPM generation fail, and is really against the package.xml format rep: http://www.ros.org/reps/rep-0127.html#license-multiple-but-at-least-one

For the packages who did this, they left it blank because the code was in public domain and was not licensed. I recommended using <license>Public Domain</license>, and all so far have adopted it.

There could also be checks for things such as properly formatted E-mail addresses for authors and maintainers, and properly formatted (and non-empy) URLs.

With the v2 package.xml spec rolling out soon, there will likely be more nuances like this that a lint tool should check.

Great work here!

@mikepurvis
Copy link
Member

I agree! This is already being tracked here: #5

The checks you're describing sound less like a linter and more like a validator, which I agree is still needed, but I'd prefer to have as part of catkin_lint or some other external tool.

@cottsay
Copy link
Member Author

cottsay commented Apr 16, 2014

Ah! I see the other ticket now.

You have a good point in that it is more like validation. I figured that the linter would be a good place, however, just because much of this does not actually break the package.xml specs, but rather just bends them.

Either way, only suggestions. I'll leave it to you to decide what to do with this ticket. If you feel these checks aren't a good fit for your tool, I understand, and you can close it :)

@mikepurvis
Copy link
Member

Will leave open for now, since there are some different ideas in here.

The ideal would be if there were schemas available for both package.xml and launchfiles which could just be validated against.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants