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

When flit init --litmus-tests is used, do not copy Empty.cpp #316

Closed
mikebentley15 opened this issue Jan 21, 2020 · 2 comments · Fixed by #324
Closed

When flit init --litmus-tests is used, do not copy Empty.cpp #316

mikebentley15 opened this issue Jan 21, 2020 · 2 comments · Fixed by #324
Assignees
Labels
documentation Involves touching documentation good first issue A good place to start python Involves touching python code tests Involves touching tests

Comments

@mikebentley15
Copy link
Collaborator

Bug Report

Describe the problem
When the user calls flit init --litmus-tests, they are likely wanting to just run the litmus tests, or use them as an example for writing their own tests.

In the first case, the user will not want the Empty.cpp test case in their list of tests since that is misleading, even if the test case is disabled when generating output.

In the second case, the user may or may not want Empty.cpp as a basis for creating their own test. I would say it is sufficient for them to look at the litmus tests as examples for how to write their own tests and Empty.cpp is unnecessary.

Suggested Fix
If the --litmus-tests option is used for flit init, then do not include Empty.cpp in the list of files to copy over.

I am not sure if documentation needs to be updated anywhere. I do not know if this functionality is currently documented.

@mikebentley15 mikebentley15 added good first issue A good place to start python Involves touching python code documentation Involves touching documentation tests Involves touching tests labels Jan 21, 2020
@mikebentley15
Copy link
Collaborator Author

I think this is a good first issue for John to take. It involves

  1. Creating a test that fails until the new functionality is implemented in tests/flit_cli/flit_init/
  2. Implement the change in scripts/flitcli/flit_init.py until the created test passes
  3. Make sure all other tests continue to pass
  4. Checking documentation to see if it needs updating

I would be happy to work with John or review his work. Whatever works for John.

@JohnJacobsonIII
Copy link
Collaborator

JohnJacobsonIII commented Jan 21, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Involves touching documentation good first issue A good place to start python Involves touching python code tests Involves touching tests
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants