Skip to content

Commit

Permalink
Document unity exec time options.
Browse files Browse the repository at this point in the history
  • Loading branch information
mvandervoord committed Mar 9, 2024
1 parent 64939db commit 2777955
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) <year> 2007-23 Mike Karlesky, Mark VanderVoord, Greg Williams
Copyright (c) <year> 2007-24 Mike Karlesky, Mark VanderVoord, Greg Williams

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 28 additions & 0 deletions docs/UnityConfigurationGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,34 @@ _Example:_
#define UNITY_OUTPUT_COLOR
```

#### `UNITY_INCLUDE_EXEC_TIME`

Define this to measure and report execution time for each test in the suite. When enabled, Unity will do
it's best to automatically find a way to determine the time in milliseconds. On most Windows, macos, or
Linux environments, this is automatic. If not, you can give Unity more information.

#### `UNITY_CLOCK_MS`

If you're working on a system (embedded or otherwise) which has an accessible millisecond timer. You can
define `UNITY_CLOCK_MS` to be the name of the function which returns the millisecond timer. It will then
attempt to use that function for timing purposes.

#### `UNITY_EXEC_TIME_START`

Define this hook to start a millisecond timer if necessary.

#### `UNITY_EXEC_TIME_STOP`

Define this hook to stop a millisecond timer if necessary.

#### `UNITY_PRINT_EXEC_TIME`

Define this hook to print the current execution time. Used to report the milliseconds elapsed.

#### `UNITY_TIME_TYPE`

Finally, this can be set to the type which holds the millisecond timer.

#### `UNITY_SHORTHAND_AS_INT`

#### `UNITY_SHORTHAND_AS_MEM`
Expand Down

0 comments on commit 2777955

Please sign in to comment.