Control: tags 848237 + patch

Attached is a patch adding a manpage for snapctl.

Content is sourced directly from snapd's own command registrations in
overlord/hookstate/ctlcmd/*.go (the addCommand() short-help strings for
each subcommand), so the description of each snapctl subcommand matches
what's actually registered in snapd 2.76.3-2 -- including correctly
leaving out "is-ready", which is present in source but explicitly
disabled (see overlord/hookstate/ctlcmd/is_ready.go, marked "temporarily
disabled to prevent partial implementation in release").

Verified:
- debian/snapctl.1 renders cleanly through groff/man, no warnings
- Patch applies cleanly against a fresh pristine 2.76.3-2 source tree
- dh_installman correctly installs it to usr/share/man/man1/snapctl.1
  after the patch is applied

Changes:
- debian/snapctl.1 (new)
- debian/snapd.manpages (register the new manpage)
- debian/changelog
diff -ruN '--exclude=.pc' '--exclude=.debhelper' pristine/debian/changelog snapd-2.76.3/debian/changelog
--- pristine/debian/changelog	2026-08-22 07:40:38.000000000 +0000
+++ snapd-2.76.3/debian/changelog	2026-10-07 07:18:32.302426731 +0000
@@ -1,3 +1,8 @@
+snapd (2.76.3-3) UNRELEASED; urgency=medium
+
+  * Add manpage for snapctl (Closes: #848237)
+
+ -- Stefan Andrei Ionut <[email protected]>  Wed, 7 Oct 2026 10:11:00 +0300
 snapd (2.76.3-2) unstable; urgency=medium
 
   * Add patch for s390x test failure
diff -ruN '--exclude=.pc' '--exclude=.debhelper' pristine/debian/snapctl.1 snapd-2.76.3/debian/snapctl.1
--- pristine/debian/snapctl.1	1970-01-01 00:00:00.000000000 +0000
+++ snapd-2.76.3/debian/snapctl.1	2026-10-07 07:18:20.355000287 +0000
@@ -0,0 +1,116 @@
+.TH SNAPCTL 1 "" "snapd" "User Commands"
+.SH NAME
+snapctl \- control commands callable from snap hooks
+.SH SYNOPSIS
+.B snapctl
+[\fIOPTIONS\fR]
+\fICOMMAND\fR
+[\fICOMMAND\-OPTIONS\fR]
+.SH DESCRIPTION
+.B snapctl
+is only meaningful when invoked from inside a running snap hook (for
+example
+.IR configure ,
+.IR install ,
+or an interface hook). When snapd runs a hook, it sets the
+.B SNAP_CONTEXT
+environment variable (and, for compatibility with older snapd releases,
+.BR SNAP_COOKIE )
+to an opaque context ID identifying that hook invocation.
+.B snapctl
+reads this ID and uses it to talk back to the running
+.B snapd
+daemon over its local socket, so that the hook can query or change state
+that belongs to that specific snap and that specific hook run.
+.PP
+Each
+.I COMMAND
+accepts its own options; run
+.B snapctl
+.I COMMAND
+.B \-\-help
+for the full usage of an individual command.
+.SH COMMANDS
+.TP
+.B get
+Print either configuration options or interface connection settings.
+.TP
+.B set
+Set either configuration options or interface connection settings.
+.TP
+.B unset
+Remove configuration options.
+.TP
+.B start
+Start services.
+.TP
+.B stop
+Stop services.
+.TP
+.B restart
+Restart services.
+.TP
+.B reboot
+Control the reboot behavior of the system.
+.TP
+.B refresh
+Print pending refreshes and optionally hold back disruptive ones.
+.TP
+.B install
+Install components.
+.TP
+.B remove
+Remove components.
+.TP
+.B services
+Query the status of services.
+.TP
+.B is\-connected
+Return success if the given plug or slot is connected.
+.TP
+.B model
+Get the active model for this device.
+.TP
+.B system\-mode
+Get the current system mode and associated details.
+.TP
+.B set\-health
+Report the health status of a snap.
+.TP
+.B fde\-setup\-request
+Obtain a full disk encryption setup request.
+.TP
+.B fde\-setup\-result
+Set the result for a full disk encryption setup request.
+.TP
+.B mount
+Create a temporary or permanent mount.
+.TP
+.B umount
+Remove a temporary or permanent mount.
+.TP
+.B kmod
+Load or unload kernel modules.
+.TP
+.B fail
+Fail a confdb change.
+.TP
+.B version
+Print version information.
+.SH ENVIRONMENT
+.TP
+.B SNAP_CONTEXT
+Opaque context ID identifying the current hook invocation. Set by
+.B snapd
+when it runs a hook; required for
+.B snapctl
+to function.
+.TP
+.B SNAP_COOKIE
+Deprecated alias for
+.BR SNAP_CONTEXT ,
+read for compatibility with older snapd releases when
+.B SNAP_CONTEXT
+is unset.
+.SH SEE ALSO
+.BR snap (1)
diff -ruN '--exclude=.pc' '--exclude=.debhelper' pristine/debian/snapd.manpages snapd-2.76.3/debian/snapd.manpages
--- pristine/debian/snapd.manpages	2026-08-21 08:02:13.000000000 +0000
+++ snapd-2.76.3/debian/snapd.manpages	2026-10-07 07:18:27.934315905 +0000
@@ -2,3 +2,4 @@
 debian/snapd.seeded.service.5
 debian/snapd.service.5
 snap.8
+debian/snapctl.1

Reply via email to