Cross-Compiler Documentation Update + Minor CodeQL Alert Resolutions #2098
Conversation
…t may give bogus warnings. Consider replacing these with //-style comments, with #if 0...#endif, or with more clearly structured multi-line comments." alert. Fixed all - Except external libraries
…d be at the beginning of the declaration." alert. All resolved.
Correct for most recent version of devel.
Svc/TlmChan/test/ut/Tester.hpp
Outdated
| U32 context /*!< | ||
| Call context value; meaning chosen by user | ||
| */ | ||
| void from_PktSend_handler(const NATIVE_INT_TYPE portNum, //!< The port number*/ |
There was a problem hiding this comment.
There are a few */ ending comments that remain we should clean those up.
Also, I was hoping we could pull all these instructions into a separate package. e.g. docs/Tutorials/CrossCompilationSetup where we talk through installing each peice and the toolchain as a separate pseudo-tutorial that would be linked from exerywhere.
Do you want to refactor that or should I?
|
@LeStarch I split the documentation into different sections:
All of the above have been added to the "CrossCompilationSetup" directory, which can be referenced in other tutorials. Note: I did remove the original "Cross-Compilation Tutorial", since it has been split into multiple sections. I can add it back if you think we need it. As for next steps, we may want to go through the other tutorials to make sure things are linked properly. |
docs/Tutorials/CrossCompilationSetup/CrossCompilationSetupTutorial.md
Outdated
Show resolved
Hide resolved
…2098) * Updates to resolve "Complex multi-line /.../-style comment found. Lint may give bogus warnings. Consider replacing these with //-style comments, with #if 0...#endif, or with more clearly structured multi-line comments." alert. Fixed all - Except external libraries * Resolve "Storage-class specifier (static, extern, typedef, etc) should be at the beginning of the declaration." alert. All resolved. * Updated F Prime Cross Compilation Documentation Correct for most recent version of devel. * Spelling Fixes * Remove URL Pattern * Added `rancherdesktop` to expect.txt * cross-compile tutorial re-organization * add macos.md and add step for running executable * clean up command to run executable * change [...] to <...> --------- Co-authored-by: Justine West <justine.a.west@jpl.nasa.gov>
Change Description
Updated cross-compiler documentation and fixed code readability as noted by CodeQL
Rationale
Resolve CodeQL alerts, fix broken cross-compiler documentation
Testing/Review Recommendations
N/A
Future Work
Continue to update for CodeQL alerts.
Fixed PR of #2096