← Back to issue list

docs: Service management with craftctl?

View original Github issue

Metadata

Project
snapcraft
Number
#5738
Type
issue
State
closed
Author
farshidtz
Labels
good first issue Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Docs typo confirmed: the snapcraft.yaml service docs said services start with `craftctl` instead of `snapctl`. Fixed by merged PR #5743 (commit 40851bddd), which also corrected the snapctl link. Follow-up PR #6048 (2d3bec6c7) fixed another craftctl->snapctl doc instance.

Resolution: closed resolved

Reason: Maintainer mr-cal confirmed the text should say snapctl, and PR #5743 (commit 40851bddd) was merged, replacing craftctl with snapctl in the service-management docs and fixing the link. A later related fix landed in #6048 (2d3bec6c7).

Evaluated by: mr-cal-bot

No scores available.

Issue body

*"snapcraft.yaml - Snapcraft 8.11.2 documentation":* https://github.com/canonical/snapcraft/blob/3f076004fa80a8950e624fd8150d3170f435a65b/snapcraft/models/project.py#L814-L818 > "the service will be started with `craftctl` and another management agent, which is most commonly a `hook`" The linked documentation doesn't explain this. How can `craftctl` be used to start a service? I was not able to get the command's usage (tried --help/-h/help). Perhaps this meant to say: "the service can be started with `snapctl`, most commonly from `hook`" ? --- *Reported from: https://documentation.ubuntu.com/snapcraft/stable/reference/project-file/snapcraft-yaml/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs typo confirmed: the snapcraft.yaml service docs said services start with `craftctl` instead of `snapctl`. Fixed by merged PR #5743 (commit 40851bddd), which also corrected the snapctl link. Follow-up PR #6048 (2d3bec6c7) fixed another craftctl->snapctl doc instance.
stealth/space-bunny-alpha — closed resolved Fixed service-management documentation by replacing craftctl with snapctl in merged PR #5743 (40851bddd), resolving #5738.
stealth/space-bunny-alpha — closed resolved Fixed in merged PR #5743 (commit 40851bddd), correcting service-management documentation from craftctl to snapctl and linking snapctl usage guidance.
qwen/qwen3.6-35b-a3b — — Documentation error acknowledged. Confirmed correct command is snapctl. Issue closed after contributor volunteered to submit a PR updating the text and clarifying craftctl versus snapctl usage.
qwen/qwen3.6-35b-a3b — — Closed awaiting a PR to fix a documentation typo. The text incorrectly referenced craftctl instead of snapctl for service management, which was confirmed and will be updated with clarifying notes.
qwen/qwen3.6-35b-a3b — — Closed pending a pull request that will fix the documentation typo, replacing craftctl with snapctl and clarifying service management commands.
qwen3.6-35b-a3b-mtp-q6 — — Documentation typo identified where craftctl should be snapctl. Maintainer confirmed the correction, and a contributor submitted a PR to update the text and clarify the distinction. The issue was closed after the documentation fix was merged.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/snapcraft#5743 (confidence 97%)

    Merged PR 'docs: correct snapctl link' (commit 40851bddd) explicitly fixes #5738

  • Related To: canonical/snapcraft#6048 (confidence 80%)

    Later PR corrected another craftctl->snapctl occurrence in the config docs

  • Related To: canonical/snapcraft#5730 (confidence 25%)

    Unrelated schema/validation change touching craftctl wording only in the same era

Related issues

Issue Project State Summary Similarity
#5743 docs: fix service management to snapctl snapcraft merged Merged docs PR #5743 (commit 40851bddd) fixed the snapcraft.yaml daemon reference: replaced craftctl with snapctl for runtime service management and corrected the intersphinx link. Fixes #5738.
84%
#6048 docs: correct 'craftctl' to 'snapctl' in config doc snapcraft merged Merged #6048 via 2d3bec6c7, correcting the config guide from craftctl to snapctl. The intersphinx link update was intentionally deferred to separate work.
81%
#1091 docs: revamp craftctl how-to craft-parts merged Merged PR #1091 as 44aa6508, revamping the craftctl how-to with upstream Snapcraft guidance and adding a 2.10.0 changelog entry.
74%