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

cram: add documentation for the -p option #59

Merged
merged 1 commit into from Jan 23, 2022

Conversation

ani-sinha
Copy link
Contributor

@ani-sinha ani-sinha commented Jan 18, 2022

Document the '-p'/'--patch' option in the help string.

Signed-off-by: Ani Sinha ani@anisinha.ca

Copy link
Member

@Snaipe Snaipe left a comment

Choose a reason for hiding this comment

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

LGTM, just one nit.

test/cram.sh Outdated
-p/--patch If there is a difference between the expeted output and the
actual output, the expected output in the file will be patched
by the actual output. Setting the environment variable
'$ENV_CRAM_PATCH' has the same effect. The environment variable
Copy link
Member

Choose a reason for hiding this comment

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

CRAM_PATCH=1 already does this; I'd just document it as is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I am an idot! I re-invented the wheel in a convoluted manner. Fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

btw while we are here, I was telling Ken how good your awk skiils are! but for idiots like me, could you please add some comments on the parsing logic so that I can follow?

Copy link
Member

Choose a reason for hiding this comment

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

Hey, don't sell yourself short 🙂 My awk skills aren't too impressive, I know awk wizards out there and I'm not yet at that level.

I'll add some comments to explain some of the magic.

Document the '-p'/'--patch' option in the help string.

Signed-off-by: Ani Sinha <ani@anisinha.ca>
@ani-sinha ani-sinha changed the title cram: add documetation and enhance the -p option cram: add documentation for the -p option Jan 20, 2022
@Snaipe Snaipe merged commit 6be96a2 into aristanetworks:main Jan 23, 2022
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.

None yet

2 participants