onfail_stop is not documented

[gtmanfred]

Description of Issue/Question

the onfail_stop requisite is not documented.

It seems that it stops the states marked as onfail from being errored if an onfail_stop state succeeds.

[gtmanfred]

Also, if that is how it works, then #16291 should be closed.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[max-arnold]

Bump

[stale]

Thank you for updating this issue. It is no longer marked as stale.

[OrangeDog]

If that is what it does then it's a bad name. It sounds like it should stop execution in some way.

Before it's documented (and officially supported) change it to e.g. onfail_suppress, or a more composable way of doing it.

[CrackerJackMack]

I agree with the shit naming. But this is precisely what I need for functionality. At least documenting it would help.

[max-arnold]

I agree it is badly named, the usage is not intuitive, and it is not a requisite but a flag, and the flag is true by default:

Failing state:
  test.fail_without_changes: []

Failing state handler:
  test.succeed_with_changes:
    - onfail_stop: false
    - onfail:
      - test: Failing state

salt-call state.apply onfail_stop >/dev/null; echo $?
[ERROR   ] Failure!
0

What this does is ensures the resulting retcode is 0. See #39874