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

docs: make the documentation for --etag-save match the program behaviour #7429

Closed
wants to merge 1 commit into from
Closed

docs: make the documentation for --etag-save match the program behaviour #7429

wants to merge 1 commit into from

Conversation

@maxz
Copy link
Contributor

@maxz maxz commented Jul 18, 2021

When using curl with the option --etag-save I expected it to save the ETag without its surrounding quotes, as stated by the documentation in the repository and by the generated man pages.

My first endeavour was to fix the program, but while investigating the history of the relevant parts, I discovered that curl once saved the ETag without the quotes.
This was undone by Daniel Stenberg (@bagder) in commit 98c94596f5928840177b6bd3c7b0f0dd03a431af, therefore I decided that in this case the documentation should be adjusted to match the behaviour of curl.

The changed save behaviour also made parts of the --etag-compare documentation wrong or superfluous, so I adjusted those accordingly.

@maxz maxz changed the title Make the documentation for --etag-save match the program behaviour. docs: Make the documentation for --etag-save match the program behaviour. Jul 18, 2021
@maxz maxz changed the title docs: Make the documentation for --etag-save match the program behaviour. docs: make the documentation for --etag-save match the behaviour Jul 18, 2021
@maxz maxz changed the title docs: make the documentation for --etag-save match the behaviour docs: make the documentation for --etag-save match the program behaviour Jul 18, 2021
When using curl with the option `--etag-save` I expected it to save the
ETag without its surrounding quotes, as stated by the documentation in
the repository and by the generated man pages.

My first endeavour was to fix the program, but while investigating the
history of the relevant parts, I discovered that curl once saved the
ETag without the quotes.
This was undone by Daniel Stenberg in commit `98c94596f5928840177b6bd3c7b0f0dd03a431af`,
therefore I decided that in this case the documentation should be
adjusted to match the behaviour of curl.

The changed save behaviour also made parts of the `--etag-compare`
documentation wrong or superfluous, so I adjusted those accordingly.
@bagder
bagder approved these changes Jul 18, 2021
@bagder
Copy link
Member

@bagder bagder commented Jul 18, 2021

Thanks!

@bagder bagder closed this in eaab3f0 Jul 18, 2021
@maxz maxz deleted the maxz:fix-etag-save-documentation branch Jul 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants