nuttxpr commented on PR #14147: URL: https://github.com/apache/nuttx/pull/14147#issuecomment-2408428508
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) This Pull Request as described **does not meet** NuttX requirements. **Here's why and how to fix it:** * **Missing Information:** The PR description lacks critical details about the changes made. * **Purpose:** Is this a new feature (adding `showsize.sh`)? Is it fixing a bug in an existing script? * **Functionality:** How does `showsize.sh` work? What problem does it solve? * **Code Explanation:** What code changes were made? Be specific. * **Impact Assessment:** The impact section is far too brief. * **User Impact:** Will users need to use this script? How? Provide clear instructions. * **Build Impact:** Does this script affect the NuttX build process in any way? * **Documentation:** Does `showsize.sh` require documentation? If so, has it been added? * **Insufficient Testing:** The testing section is inadequate. * **Build Hosts:** Specify the operating systems, compilers, and architectures used for testing. * **Target Details:** Provide specific information about the target hardware (e.g., `arm:stm32f4discovery:nsh`). * **Meaningful Logs:** The provided logs are useless. Include logs that demonstrate: * The problem that existed *before* your change. * How your change fixes the problem (show the output *after* your change). **Example of an Improved Summary** ``` ## Summary This PR introduces a new tool, `tools/showsize.sh`, designed to display the top 10 largest sections in an ELF file. This is particularly useful for understanding memory usage in NuttX builds. The script takes the path to an ELF file as an argument and uses the `arm-none-eabi-size` (or equivalent) tool to extract and display section size information. ## Impact * **New Feature:** Adds the `showsize.sh` utility. * **User Impact:** Users can now utilize `showsize.sh <elf_file>` to analyze ELF file sizes. * **Documentation:** Documentation for `showsize.sh` has been added to the `tools/` directory README. ## Testing **Build Host:** * OS: Ubuntu 20.04 * Compiler: arm-none-eabi-gcc (version 10.3.1) **Target:** * Architecture: ARM * Board: STM32F4 Discovery (`arm:stm32f4discovery:nsh`) **Testing Logs (Before):** (Example - show that you couldn't easily analyze ELF size before) ``` $ ls -l my_nuttx_app.elf -rwxr-xr-x 1 user user 123456 Jul 12 10:00 my_nuttx_app.elf ``` **Testing Logs (After):** ``` $ ./tools/showsize.sh my_nuttx_app.elf Top 10 largest sections in my_nuttx_app.elf: text data bss dec hex filename 524288 8192 4096 536576 84000 [Code] 131072 0 0 131072 20000 .rodata 65536 0 0 65536 10000 .data ... (rest of the output) ... ``` ``` **Remember:** Adapt this example to your specific changes and provide clear, concise, and complete information. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
