Google test documentation update #10608
Open
Conversation
This file contains 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
tianocore-assign-reviewers
bot
requested review from
makubacki,
mdkinney and
spbrogan
VivianNK
force-pushed
the
googleTestDocumentationUpdate_v1
branch
from
2984a72 to
3177ec2
Compare
VivianNK
commented
Jan 10, 2025
| @@ -687,6 +726,8 @@ declarations as shown in the below table. | |||
| | Global Table (e.g. gRT, gBS, etc.) | gRT->GetVariable | gRT_GetVariable | | |||
| | Protocol | UsbIoProtocol->UsbPortReset | UsbIoProtocol_UsbPortReset | | |||
|
|
|||
| __Note__ the naming convention for global tables and protocols is currently being discussed. Points of discussion include removing the use of underscores, use of "Efi," and including the use case, e.g. `Protocol` in the mock function name. | |||
There was a problem hiding this comment.
@mdkinney Here is a note on the naming convention
Split the ReadMe.md into the base file, and the two supporting files. The two files are dedicated to unit test implementation details for Framework and GoogleTest. Signed-off-by: Vivian Nowka-Keane <[email protected]>
VivianNK
force-pushed
the
googleTestDocumentationUpdate_v1
branch
from
3177ec2 to
15c42e9
Compare
Update the ReadMe files. Signed-off-by: Vivian Nowka-Keane <[email protected]>
Include updated information on mocking protocols and PPIs. Signed-off-by: Vivian Nowka-Keane <[email protected]>
VivianNK
force-pushed
the
googleTestDocumentationUpdate_v1
branch
from
15c42e9 to
efedb15
Compare
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
Break off UnitTestFrameworkPkg ReadMe unit test implementation details into different markdown files.
Add details to GoogleTest file to include newer details in creating mocks for non-libraries.
How This Was Tested
CI
Integration Instructions
N/A