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

chore: Update systemd description #5250

Merged
merged 2 commits into from
May 2, 2024

Conversation

holmanb
Copy link
Member

@holmanb holmanb commented May 1, 2024

Proposed Commit Message

chore: Update systemd description

The current descriptions do not follow systemd guidance and are misleading since some services have multiple roles.

systemd.unit(5) on Description:

    A short human readable title of the unit. This may be used by systemd
    (and other UIs) as a user-visible label for the unit, so this string
    should identify the unit rather than describe it, despite the name.

Yet these service files attempt to describe the unit rather than identify it.

Before:
May 01 09:49:49.238629 tiny systemd[1]: Starting cloud-config.service - Apply the settings specified in cloud-config...


After:
May 01 09:49:49.238629 tiny systemd[1]: Starting cloud-config.service - Cloud-init: Config Stage...

Additional Context

There's also the fact that the service files allude to the hotplug command being a daemon when it actually isn't, but that's for a different PR.

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

The current descriptions do not follow systemd guidance and are misleading
since some services have multiple roles.

systemd.unit(5) on Description=:

    A short human readable title of the unit. This may be used by systemd
    (and other UIs) as a user-visible label for the unit, so this string
    should identify the unit rather than describe it, despite the name.

Yet these service files attempt to describe the unit rather than identify it.

Before:
```
May 01 09:49:49.238629 tiny systemd[1]: Starting cloud-config.service - Apply the settings specified in cloud-config...
```

After:
```
May 01 09:49:49.238629 tiny systemd[1]: Starting cloud-config.service - Cloud-init: Config Stage...
```
Copy link
Collaborator

@blackboxsw blackboxsw left a comment

Choose a reason for hiding this comment

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

Other than a nit for a slightly more details suffix for init-local +1

Co-authored-by: Chad Smith <chad.smith@canonical.com>
@holmanb holmanb merged commit b5b4dd3 into canonical:main May 2, 2024
27 of 28 checks passed
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