Skip to content
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

Clarify README for CLI options #218

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Clarify README for CLI options #218

merged 1 commit into from
Oct 31, 2022

Conversation

rnc
Copy link
Collaborator

@rnc rnc commented Oct 31, 2022

Fixes #207
Fixes #194

@rnc rnc changed the title Clarify README for --tag Clarify README for CLI options Oct 31, 2022
@goldmann
Copy link
Owner

goldmann commented Oct 31, 2022

@rnc I imagine you wanted to change this:

def run(self):
parser = MyParser(
description='Docker layer squashing tool')
parser.add_argument(
'-v', '--verbose', action='store_true', help='Verbose output')
parser.add_argument(
'--version', action='version', help='Show version and exit', version=version)
parser.add_argument('image', help='Image to be squashed')
parser.add_argument(
'-d', '--development', action='store_true', help='Does not clean up after failure for easier debugging')
parser.add_argument(
'-f', '--from-layer', help='Number of layers to squash or ID of the layer (or image ID or image name) to squash from. In case the provided value is an integer, specified number of layers will be squashed. Every layer in the image will be squashed if the parameter is not provided.')
parser.add_argument(
'-t', '--tag', help="Specify the tag to be used for the new image. If not specified no tag will be applied")
parser.add_argument(
'-m', '--message', help="Specify a commit message (comment) for the new image.")
parser.add_argument(
'-c', '--cleanup', action='store_true', help="Remove source image from Docker after squashing")
parser.add_argument(
'--tmp-dir', help='Temporary directory to be created and used')
parser.add_argument(
'--output-path', help='Path where the image should be stored after squashing. If not provided, image will be loaded into Docker daemon')

Readme just reflects whats in the CLI.

@goldmann
Copy link
Owner

Ah, all good, I was reading wrongly the diff.

@goldmann goldmann merged commit b515870 into goldmann:main Oct 31, 2022
@rnc rnc deleted the ISSUE207 branch October 31, 2022 09:34
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.

-t not defaulting to image Usage in README not same as cli output
2 participants