add --break for requesting a debug shell

Similar to rd.break for dracut this allows a user to specify:

- --break or --break=*
    - to get a shell before each stage is run
- --break=stage.name
    - to get a shell each time the stage with that name is run
    - example: --break=org.osbuild.copy
- --break=stage.id
    - to get a shell each time the stage with that ID is run
    - get the ID for the stages for your manifest by running
      osbuild on the manifest with --inspect
    - example: --break=dc6e3a66fef3ebe7c815eb24d348215b9e5e2ed0cd808c15ebbe85fc73181a86

and get a bash shell where they can inspect the environment to debug
and develop OSBuild stages.
This commit is contained in:
Dusty Mabe 2024-01-08 23:19:44 -05:00 committed by Brian C. Lane
parent 962b7f4d4b
commit 83a14886d3
4 changed files with 26 additions and 8 deletions

View file

@ -57,6 +57,8 @@ is not listed here, **osbuild** will deny startup and exit with an error.
--monitor-fd=NUM file-descriptor to be used for the monitor
--stage-timeout set the maximal time (in seconds) each stage is
allowed to run
--break, --break=ID open debug shell when executing stages; accepts
stage name or id (from --inspect) or * (for all)
NB: If neither ``--output-directory`` nor ``--checkpoint`` is specified, no
attempt to build the manifest will be made.