[sonic-slave]: Add remake to debug makefiles #18891
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
* Remake supports GDB style debugging for makefiles making it easier to traverse complicated makefiles and stepping through builds
lguohan
approved these changes
May 8, 2024
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.
Remake supports GDB style debugging for Makefiles making it easier to traverse complicated Makefiles and stepping through build steps, printing variables etc. It supports most of the well-known GDB commands for breakpoints, printing, stepping etc.
https://bashdb.sourceforge.net/remake/
Why I did it
remakeenables developers to debug Makefiles.Work item tracking
Not applicable
How I did it
Add remake to the apt install list.
How to verify it
Running remake from inside the slave container. For instance, running remake with the
-Xoption starts the debugger.remake -X -f slave.mk PLATFORM=vs ... EXTRA_DOCKER_TARGETS=docker-ptf.gz busterwill run the Makefile and dump into a prompt for further debugging.
Which release branch to backport (provide reason below if selected)
Not applicable.
Tested branch (Please provide the tested image version)
Not applicable.
Description for the changelog
Add remake to sonic-slave buster, bullseye and bookworm images for easier Makefile debugging
Link to config_db schema for YANG module changes
Not applicable
A picture of a cute animal (not mandatory but encouraged)