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.

Sign up for GitHub

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

Jump to bottom

Suggestion : Un-document the -configfile parameter. #507

Closed
ryaneberly opened this issue Dec 28, 2017 · 4 comments
Closed

Suggestion : Un-document the -configfile parameter. #507

ryaneberly opened this issue Dec 28, 2017 · 4 comments
Assignees
@TheRealAgentK
Milestone
1.3.0

Comments

@ryaneberly
Copy link
Contributor

I suggest we remove the configfile parameter from the help prompt and README. It is not intended for the average user. .cflintrc is the preferred way to configure the tool.

I think @TheRealAgentK recommended this a while back as well.
@TheRealAgentK
Copy link
Collaborator

Yes, I'm still all for that. Anything that makes the configuration less complex will be good.

@TheRealAgentK TheRealAgentK self-assigned this Dec 28, 2017
@TheRealAgentK
Copy link
Collaborator

Will change the documentation for it tomorrow.

@KamasamaK
Copy link
Collaborator

I was only using this parameter in my extension(s) to

  1. Force the proper .cflintrc to be used because automated searching was not working with -stdin previously. This appears to be fixed.
  2. Override or fallback on a given alternate configuration. I do not have any metrics on whether this is really being used by anyone.

TheRealAgentK added a commit to TheRealAgentK/CFLint that referenced this issue Dec 30, 2017
@TheRealAgentK
cflint#507 - Removed and reworded documentation around the -configfil…
981c2ef 
…e argument

cflint#411 - Added info on getting 3rd party projects added to README.md
@TheRealAgentK TheRealAgentK mentioned this issue Dec 30, 2017
Merged
@TheRealAgentK
Copy link
Collaborator

Done in ca12fd3 (merged into dev)

@TheRealAgentK TheRealAgentK added this to the 1.3.0 milestone Dec 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TheRealAgentK TheRealAgentK

Labels
None yet
Projects
None yet
Milestone
1.3.0
Development

No branches or pull requests
3 participants
@TheRealAgentK @ryaneberly @KamasamaK