Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 0 additions & 67 deletions docs/explanation/faq.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/explanation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Chisel was created to build a minimal, secure Ubuntu root file systems.
:maxdepth: 1

mode-of-operation
faq
```
## Package slices
Slices are defined via slice definition files and follow naming conventions.
Expand Down
4 changes: 3 additions & 1 deletion docs/explanation/mode-of-operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ the corresponding package tarballs.

Chisel groups and merges all slice definitions per package. Then,
for every package, it extracts the **specified slices' paths** into
the provided root file system.
the provided root file system. Files ownership (UID:GID) is not
preserved during this process. The owner of the extracted files
is the current user.

</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/chisel-releases/chisel.yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Tells Chisel which Ubuntu archives to fetch packages from.

```{note}
Chisel only supports fetching packages from the official Ubuntu archives,
including ESM.
including ESM. The use of PPAs is not supported at the moment.
```

For example:
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/chisel-releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ named `chisel.yaml` form what is called a _chisel-release_.

The {{chisel_releases_repo}} contains a number of branches for various
_chisel-releases_, matching the corresponding Ubuntu releases.
If you find a specific release missing, let the maintainers know by [creating a
new issue] in the {{chisel_releases_repo}}.


A _chisel-release_ is simply a directory with the following structure:

Expand All @@ -30,3 +33,6 @@ The following pages provide more details on:
chisel.yaml
slice-definitions
```

[creating a
new issue]: https://github.com/canonical/chisel-releases/issues/new
11 changes: 10 additions & 1 deletion docs/reference/chisel-releases/slice-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,21 @@ Although the `hello.yaml` file can be placed in a sub-directory of `slices/` e.g
Indicates the package name. It must follow the
[Debian policy for package name](https://www.debian.org/doc/debian-policy/ch-binary.html#the-package-name).

The use of arbitrary package names is not allowed; the names must be the
same as the package names in the archive to maintain a single namespace
to remember and respect.

Chisel does not support pinning package versions. Chisel always fetches
the latest version of a package from the archives. Thus, the root file
systems Chisel produces in subsequent executions may not be identical if
a package has changed in the meantime.

As indicated above, the value must also match the YAML file basename.
For example:

```yaml
package: hello
```
Comment thread
asanvaq marked this conversation as resolved.

(slice_definitions_format_archive)=

### `archive`
Expand All @@ -56,6 +64,7 @@ fetched from. If specified, Chisel fetches this package from that archive despit
{ref}`chisel_yaml_format_spec_archives_priority` settings in
{ref}`chisel_yaml_ref`.


The archive name must be defined in {ref}`chisel_yaml_format_spec_archives`.
For example:

Expand Down
Loading