Skip to content

Commit

Permalink
Update wiki (#676)
Browse files Browse the repository at this point in the history
  • Loading branch information
ladisgin authored Mar 26, 2024
1 parent a70416c commit d81bf92
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/vscode-fine-tune.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fine-tune test generation

You have already configured some settings with the _UTBot: Quickstart_ wizard, and you may change them later. You
You have already configured some settings with the _UTBot: Quickstart_ wizard, and you may change them later. You
can also adjust additional settings for your testing purposes.

Go to **File** > **Preferences** > **Settings** and navigate to **Extensions** > **UnitTestBot**.
Expand All @@ -18,12 +18,15 @@ Adjust the settings, if necessary:
| **Paths** | | |
| Build Directory | `build` | Contains `compile_commands.json` and `link_commands.json`. |
| CMake options | `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`<br>`-DCMAKE_EXPORT_LINK_COMMANDS=ON` | Options passed to CMake command to automatically build your project. |
| Initial Teardown Functions | | Relative paths to json, that contains list of initial and teardown functions. [Format example](https://github.com/UnitTestBot/UTBotCpp/blob/main/integration-tests/c-example/itf.json) |
| Source Directories | | Relative paths to the projects you would like to generate tests for. |
| Test Directory | `tests`| Relative path to a directory to store your test code. |
| **Test Generation** | | |
| Generate for Static Functions | `True` | Set to `True` to generate tests for the C static functions. |
| Verbose formatting | `False` | Set to `True` to generate structured tests with more detail. |
| Error Mode | `Failing` | _Failing_ error tests fail then run.<br>_Passing_ error tests pass the checks. |
| Different Variables Of The Same Type | `False` | set to `True` if you want different value for same type of parameters. |
| Skip object without source | `False` | set to `True` if you want skip precompiled object files. |
| **Stubs** | | |
| Use Stubs | `False` | Set to `True` to use autogenerated stubs. |
| **Visual** | | |
Expand Down

0 comments on commit d81bf92

Please sign in to comment.