Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates the parameter examples for console/file logger to match required values #452

Merged
merged 1 commit into from
Feb 6, 2023

Conversation

michael-hawker
Copy link
Contributor

@michael-hawker michael-hawker commented Feb 2, 2023

Fixes #450

  • Adds extra info about the Verbosity values
  • Fixes the examples to be correct casing and match the parameter name
  • Adds missing extra double-dash to filelogger example
  • Fixes in both the readme and the help for the console

@michael-hawker
Copy link
Contributor Author

Only issue is that I'm still having some issues with getting the extra values to work, so not sure what else is missing here:

Summary : The term 'Summary' is not recognized as the name of a cmdlet, function, script file, or operable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:143
+ ... Project -bl:slngen.binlog --consolelogger:ShowEventId;Summary;Verbosi ...
+                                                           ~~~~~~~
    + CategoryInfo          : ObjectNotFound: (Summary:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Verbosity=Detailed : The term 'Verbosity=Detailed' is not recognized as the name of a cmdlet, function, script file,
or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and
try again.
At line:1 char:151
+ ... binlog --consolelogger:ShowEventId;Summary;Verbosity=Detailed --filel ...
+                                                ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (Verbosity=Detailed:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Append : The term 'Append' is not recognized as the name of a cmdlet, function, script file, or operable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:202
+ ... ary;Verbosity=Detailed --filelogger:LogFile=slngen.log;Append;Encodin ...
+                                                            ~~~~~~
    + CategoryInfo          : ObjectNotFound: (Append:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Encoding=UTF-8 : The term 'Encoding=UTF-8' is not recognized as the name of a cmdlet, function, script file, or
operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try
again.
At line:1 char:209
+ ... etailed --filelogger:LogFile=slngen.log;Append;Encoding=UTF-8 --platf ...
+                                                    ~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (Encoding=UTF-8:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

@michael-hawker
Copy link
Contributor Author

Ah, this last part was us running from PowerShell, I had to encapsulate the parameter part in quotes.

Copy link
Collaborator

@jeffkl jeffkl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution!

@jeffkl jeffkl merged commit b19739d into microsoft:main Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Logging Parameters help examples don't work
2 participants