← 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

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Closed and resolved as a documentation typo. Confirmed craftctl should be snapctl for service management. A contributor volunteered to submit a PR to update the text and clarify the distinction.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#5743 docs: fix service management to snapctl snapcraft merged Merged documentation update correcting service management references from craftctl to snapctl. Approved by three reviewers, passed CI, squashed, and merged. Resolves #5738.
81%
#6048 docs: correct 'craftctl' to 'snapctl' in config doc snapcraft merged Merged a documentation fix correcting craftctl to snapctl in the config guide. Approved by two reviewers with passing CI checks. The update modifies one file.
81%
#1091 docs: revamp craftctl how-to craft-parts merged Merged documentation update revamping the craftctl how-to guide using upstream Snapcraft content. Approved by two reviewers, CI checks passed after fixes, and changelog updated for a minor release prior to merge.
74%
#185 craftctl: update to comply with specification craft-parts merged Merged. Updated craftctl to comply with the specification, aligning default, set, and get commands with snapctl syntax, adding name validation, and enforcing consumption protection and single-part restrictions. Approved by reviewer.
73%