docs: fix typos in comments, docstrings and log messages - #8
Open
Léon Simmons (Avicennasis) wants to merge 1 commit into
Open
Léon Simmons (Avicennasis) wants to merge 1 commit into
Léon Simmons (Avicennasis) wants to merge 1 commit into
Conversation
Corrects misspellings and doc inaccuracies in comments, docstrings and log strings. No functional changes to program logic. Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Fixes 19 verified typos / documentation inaccuracies across 4 files. All changes are in comments, docstrings and log-message strings. No identifiers were renamed and no program logic was changed.
logger_initdocstring (。->.x5,、->,);Maxmin log file size->Maximum log file sizesignature. it will->signature. It will;popout->pop out;a warning windows->a warning window;termined signing process->terminate the signing process;origninal->original;orginal->original(x2);commnad excute done->command execute done(x2, log strings);# excute sign command seperately-># execute sign command separately;'Excute Signing Command:->'Execute Signing Command:aligment->alignmentget_all_sahara_filesdocstring documented an argument namedcontents_xml_path, which is not a parameter of the function; renamed to the real parametermeta_root_pathand corrected the description accordinglyPlease review carefully
Four of these changes are inside runtime log strings rather than comments, so they change emitted log text (not behaviour):
dtlogger.info('Waiting for secure inspect commnad excute done'),dtlogger.info('secure inspect commnad excute done')anddtlogger.info('Excute Signing Command:...')insign.py. There are no tests in the repository asserting on these strings.The same misspellings also occur in
assemble.py,xblcfgint.pyandXBLConfig/elf_gen_gui.py; those were left alone to keep this change scoped, and are happy to include them if you would prefer a single sweep.Commit is DCO signed off as required by CONTRIBUTING.md.