← Back to issue list

docs: Add `snap run --strace` discussion to the “Debug a Snap” Guide

View original Github issue

Metadata

Project
snapcraft
Number
#5900
Type
issue
State
open
Author
hillpd
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

Docs request to document `snap run --strace` in the 'Debug a Snap' how-to. Confirmed by bepri that the content was lost in an earlier docs migration; no strace references remain anywhere in docs/.

Suggested action: keep open

Reason: Maintainer @bepri explicitly acknowledged the gap: "it might've existed before, but it was lost in a recent overhaul/migration of our docs," and that the page's bottom "Debugging snaps" link now redirects back to the same page. Repo inspection confirms the gap is real: grep for "strace" across the repo returns zero matches, and docs/how-to/debugging/debug-a-snap.rst only has a "Debug with snapd" section that defers to an intersphinx link (`how-to-guides-fix-common-issues-debug-snaps`) instead of documenting the flag. The work is a small, clearly-scoped addition to an existing page with an identified target section, so it should stay open; the main residual uncertainty is that the actual page content must be authored from snap(8)/snapd docs rather than supplied by the reporter.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 18 Complexity: 15 Confidence: 88 Actionability: 85

Issue body

Adding a short section would help developers understand how to capture syscalls inside snap confinement. This functionality isn’t documented anywhere outside the `snap(8)` manpage, so surfacing it in the debugging guide would make it more discoverable. --- *Reported from: https://documentation.ubuntu.com/snapcraft/stable/how-to/debugging/debug-a-snap/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 25
Quick Win: 18
Complexity: 15
Confidence: 88
Actionability: 85
keep open Docs request to document `snap run --strace` in the 'Debug a Snap' how-to. Confirmed by bepri that the content was lost in an earlier docs migration; no strace references remain anywhere in docs/.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 85
Actionability: 80
keep open Documentation request to add `snap run --strace` usage to the Debug a Snap guide. Currently missing from docs despite being available in snap(8).
qwen/qwen3.8-27b
Impact: 25
Quick Win: 21
Staleness: 55
Complexity: 15
Confidence: 70
Support Request: 0
keep open Docs request to add a `snap run --strace` section to the 'Debug a Snap' guide for capturing syscalls under confinement. Maintainer acknowledged it was likely lost in a docs migration; no strace content exists in the repo yet.
qwen/qwen3.6-35b-a3b
Staleness: 65
Complexity: 15
Confidence: 80
Support Request: 0
keep open Request to add snap run --strace documentation to the Debug a Snap guide. Currently unaddressed after a maintainer acknowledged it may have been lost during a docs overhaul.
qwen3.6-35b-a3b-mtp-q6
Staleness: 65
Complexity: 10
Confidence: 75
Support Request: 0
needs triage Request to add snap run --strace documentation to the Debug a Snap guide. Acknowledged by a contributor who notes the content may have been lost during a recent docs migration. Currently awaiting implementation.

Update history

No update history recorded yet.

Related work

  • Related To: snapcraft#5373 (confidence 60%)

    Commit 2dfb26407 'docs: migrate "debug a snap" (#5373)' is the only migration-era commit whose diff matches 'strace', consistent with bepri's claim the content was dropped during the docs migration/reorganisation (#5440).

Related issues

No related issues found above the similarity threshold.