docs: Explain --fail-early does not imply --fail #1375

Closed
wants to merge 1 commit into
from

Projects

None yet

2 participants

@jay
Owner
jay commented Mar 31, 2017 edited

I made a mistake in some scripts replacing --fail with --fail-early, not remembering the latter doesn't imply the former. You'd think I would know since it looks like I may have been one of the initial reviewers but I don't remember it.

For example I get a bunch of files using --fail-early --location --remote-name-all and they were all written even though one had failed. I think it's an easy mistake to make, and so it should be documented that it's for transfer errors and does not imply --fail but can be combined with it.

Not in this commit:
The short help could be modified as well, but it may be overkill?

 -f, --fail          Fail silently (no output at all) on HTTP errors (H)
     --fail-early    Fail and exit on first transfer error; can use with --fail
@jay jay docs: Explain --fail-early does not imply --fail
Closes #xxxx
6747707
@jay jay added the documentation label Mar 31, 2017
Owner
bagder commented Mar 31, 2017

I'm 👍 on the main change, but I'm not too fond of the short help suggestion. I think that area is just too tight to make it make sense. "can use with --fail" doesn't really explain it.

@jay jay added a commit that closed this pull request Mar 31, 2017
@jay jay docs: Explain --fail-early does not imply --fail
Closes #1375
15b8c67
@jay jay closed this in 15b8c67 Mar 31, 2017
@jay jay deleted the jay:doc_improve_fail-early branch Mar 31, 2017
Owner
jay commented Mar 31, 2017

Ok, thanks for the review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment