refactor(windows): clean up logging #11921
Merged
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
* Remove unused parameters from SendDebugMessage functions * Add SendDebugEntry and SendDebugExit functions for tracking function entry/exit * Add indenting and function names to log entries * Remove unused debug functions * Eliminate now-unused hwnd parameter in initialization functions * Replace Log,LogEntry,LogExit functions with SendDebug equivalents in kmtip Many functions now have SendDebugEntry/SendDebugExit (or return_SendDebugExit) pairs. It is important to SendDebugExit on all returns from a function to keep the log indent depth consistent. In some cases I chose not to add these logging calls, e.g. on frequently called functions such as the message hooks.
keymanapp-test-bot
bot
added
the
user-test-required
User Test ResultsTest specification and instructions
Test Artifacts
|
Test Results
|
keymanapp-test-bot
bot
removed
the
user-test-required
Base automatically changed from
refactor/windows/11917-remove-wm_keyman_key
to
master
July 3, 2024 20:58
mcdurdin
commented
Jul 4, 2024
| @@ -206,7 +206,7 @@ BOOL RegistryReadOnly::WrapError(DWORD res) | |||
| { | |||
| /*if(res != ERROR_SUCCESS) | |||
| { | |||
| SendDebugMessageFormat(0,KDS_PROGRAM,0,"RegistryFullAccess::WrapError = %d", res); | |||
| __logerror(0,KDS_PROGRAM,0,"RegistryFullAccess::WrapError = %d", res); | |||
There was a problem hiding this comment.
this is commented out; just removing ref to SendDebugMessageFormat as this is a shared file
rc-swag
reviewed
Jul 4, 2024
|
Noteː there may be something going on with performance once debugging is enabled -- I was finding significant lag while the debugging was enabled. Needs further verification before we merge |
|
Need to disable |
rc-swag
approved these changes
Jul 8, 2024
Co-authored-by: rc-swag <[email protected]>
Co-authored-by: rc-swag <[email protected]>
Co-authored-by: rc-swag <[email protected]>
mcdurdin
commented
Jul 23, 2024
|
Changes in this pull request will be available for download in Keyman version 18.0.77-alpha |
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.
SendDebugMessage*functionsSendDebugEntryandSendDebugExitfunctions for tracking function entry/exithwndparameter in initialization functionsLog,LogEntry,LogExitfunctions withSendDebug*equivalents in kmtipKeyman_WriteDebugEvent2W,Keyman_SendDebugEntry,Keyman_SendDebugExitMany functions now have
SendDebugEntry/SendDebugExit(orreturn_SendDebugExit) pairs. It is important toSendDebugExiton all returns from a function to keep the log indent depth consistent. In some cases I chose not to add these logging calls, e.g. on frequently called functions such as the message hooks.User Testing