Skip to content

Add cleanup example in README #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

neha170
Copy link
Contributor

@neha170 neha170 commented Aug 31, 2023

Add an example on how to use cleanup option in README

@@ -41,6 +41,9 @@ ls out/RPMS/x86_64/
# Run the tools manually
make build-packages SRPM_PACK_LIST="hello_world_demo" -j$(nproc)

# Clean up Mariner workspace, and docker image and container. This requires root privileges
sudo ./CBL-MarinerTutorials/mariner-docker-builder.sh --mariner_dir /path/to/CBL-Mariner -c
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious, can the -c be placed anywhere, or does it have a specific position in the arguments list?

Copy link
Contributor Author

@neha170 neha170 Aug 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it has to be specifically at the end, that's why adding this in README

Copy link
Contributor

@christopherco christopherco Aug 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any mention in the comment itself, so one could easily not realize -c must be placed at the end of the argument list.

And I do wonder if the option should be handled differently so the placement is flexible for the user, or it is at a consistent spot relative to other shorthand arguments like -i, which comes immediately after ./CBL-MarinerTutorials/mariner-docker-builder.sh. It can be hard to keep track that -i should come at the start and -c should be at the end of any user invocation

Copy link
Contributor

@christopherco christopherco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting for the explicit mention in the documentation of the quirk that -c must be placed at the end of the argument list

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants