← Back to issue list

docs: document the `build-aux` directory

View original Github issue

Metadata

Project
snapcraft
Number
#5282
Type
issue
State
closed
Author
mr-cal
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Documentation for the build-aux directory was added via pull request #5466, resolving the request to explain its purpose as an alternative snap directory location.

Suggested action:

No scores available.

Issue body

### What needs to get done Add documentation about the `build-aux` directory. It belongs with documentation that describes where a `snapcraft.yaml` can be located. ### Why it needs to get done The use and purpose of `build-aux` isn't documented. The [`build-aux` directory](https://github.com/canonical/snapcraft/blob/02433aa1bcef717b79c0b9a2d163472fe2abe2d7/snapcraft/application.py#L166) is an alternative location to place the `snap` directory for a project. This is used by snapd because it has a conflicting [top-level snap](https://github.com/canonical/snapd/tree/master/snap) directory.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Documentation for the build-aux directory was added via pull request #5466, resolving the request to explain its purpose as an alternative snap directory location.
qwen/qwen3.6-35b-a3b Documentation for the build-aux directory was added to clarify its purpose as an alternative snap directory location. The request was resolved and merged in pull request #5466.
qwen3.6-35b-a3b-mtp-q6 Documentation for the build-aux directory was added in pull request #5466, resolving the request to explain its purpose as an alternative snap directory location. The issue is now closed.
qwen3.6-35b-a3b-mtp-q6 Documentation for the build-aux directory was merged via pull request #5466, clarifying its role as an alternative snap directory for snapd compatibility.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2496 many: support the use of build-aux/snap snapcraft merged Merged implementation adding build-aux/snap as an alternate directory for snapcraft assets. Approved by reviewer, passed CI, and modified 7 files (+207/-64 lines) to align with GNOME project conventions.
71%
#274 fix: add build-aux location for snapcraft project fetch-service merged Merged to add the build-aux location for the snapcraft project. Approved by two reviewers, the change updates two files with a net addition of five lines. The maintainer merged it from main to resolve an OSV issue.
70%