Added a tutorial for running and creating unit tests. #2554
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nedsels
force-pushed
the
update_quickstart_fix
branch
from
00bae72 to
eca55b8
Compare
github-actions
bot
added
libarchfpga
nedsels
force-pushed
the
update_quickstart_fix
branch
from
eca55b8 to
a5c8733
Compare
nedsels
force-pushed
the
update_quickstart_fix
branch
from
a5c8733 to
07547a3
Compare
|
@vaughnbetz Please review |
vaughnbetz
reviewed
May 23, 2024
README.developers.md
Outdated
| ```shell | ||
| #include "catch2/catch_test_macros.hpp" | ||
|
|
||
| // To choose a tag, see examples from when you run ./test_vpr --list-tests in the test exectuable directory, |
There was a problem hiding this comment.
Should this be "to choose a test name" (not tag).
README.developers.md
Outdated
| #include "catch2/catch_test_macros.hpp" | ||
|
|
||
| // To choose a tag, see examples from when you run ./test_vpr --list-tests in the test exectuable directory, | ||
| // as shown earlier. A good default tag name is the name of the test: in this case, [vpr]. |
There was a problem hiding this comment.
Does this mean the syntax below ([test_tag]) will be filled in with [vpr]? Or are you saying [vpr] would be a good tag name for a test of a feature within the vpr code base?
I think clarifying this text a bit would be good.
There was a problem hiding this comment.
It is meant to give a recommendation for the tag in square brackets. I've changed it now so that hopefully this is clear
nedsels
force-pushed
the
update_quickstart_fix
branch
from
07547a3 to
f13a5b0
Compare
|
Looks good -- thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Modified the Developer Guide to give a basic tutorial for how to (1) run testers and (2) create unit tests, including a simple example. Also added
test_archfpgato the list of tests that are run bymake test.Motivation and Context
There was only a brief tutorial on how to run unit tests in the guide previously: one instruction to run
make && make test. This is not very helpful for anyone wanting to create their own unit tests, or run individual tests that target part of the software.Types of changes
Checklist: