dbus: clarify PropExecStart uncleanIsFailure semantics - #526
Open
MsfPablo wants to merge 1 commit into
Open
Conversation
The argument and the corresponding field are named after the negation of the systemd property they map to: true means *ignore* unclean exits, not treat them as failures. Without explanation, users reasonably assume the opposite, as flagged in issue coreos#510. Clarify the doc-comments for both the field and the function so the inverted semantics are spelled out, while keeping the public API (field name, argument name, dbus property name) unchanged for backward compatibility. Fixes coreos#510
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #510
The
PropExecStartargumentuncleanIsFailureand the correspondingexecStart.UncleanIsFailurefield are named after the negation of thesystemd property they map to:
truemeans ignore unclean exits(equivalent to prefixing the command with
-in a unit file and tosystemd's
arg_ignore_failure), whilefalse(the default) treatsunclean exits as failures. Without explanation, users reasonably assume
the opposite, as flagged in #510.
This change only updates the doc-comments for the field and the function
so the inverted semantics are spelled out. The public API
(field name, argument name, dbus property name) is intentionally left
unchanged for backward compatibility — a rename would be a breaking
change to a documented public function with no deprecation path.
AI disclosure
This patch was authored with the assistance of an AI coding assistant
(Claude). I reviewed the change, ran
gofmt,go vet, andgo build ./dbus/...locally — all clean.