-
Notifications
You must be signed in to change notification settings - Fork 10
docs: redistribute faq content to relevant sections (fixes #39) #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,5 +7,4 @@ This section of the documentation covers the core concepts of Chisel. | |
|
|
||
| mode-of-operation | ||
| slices | ||
| faq | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,7 +29,9 @@ Chisel uses the {{cut_cmd}} to _slice_ Ubuntu packages, as depicted in the workf | |
|
|
||
| Chisel fetches, reads and validates the {ref}`chisel-release<chisel-releases_ref>`. | ||
| This includes parsing the {ref}`chisel_yaml_ref` and {ref}`slice | ||
| definitions<slice_definitions_ref>` while validating the release and checking for conflicting paths across packages. | ||
| definitions<slice_definitions_ref>` while validating the release and checking for | ||
| conflicting paths across packages. Slice definitions for each Ubuntu release are | ||
| located in the corresponding `ubuntu-XX.YY` branch of the {{chisel_releases_repo}}. | ||
|
|
||
| </td> | ||
| </tr> | ||
|
|
@@ -50,7 +52,14 @@ definitions<slice_definitions_ref>` while validating the release and checking fo | |
| Chisel talks to the {ref}`chisel_yaml_format_spec_archives` directly. | ||
| It fetches, validates and parses their `InRelease` files. | ||
| It then resolves which archive holds the **requested** packages and fetches | ||
| the corresponding package tarballs. | ||
| the corresponding package tarballs. Chisel always fetches the latest version of | ||
| a package from the archives, and does not support pinning package versions. | ||
| Thus, the root file systems Chisel produces in subsequent executions may not be | ||
| identical if a package has changed in the meantime. | ||
|
|
||
| The supported archives are described at | ||
| {ref}`chisel_yaml_format_spec_archives`; non-Ubuntu archives and PPAs are not | ||
| supported. | ||
|
Comment on lines
+60
to
+62
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This information is already in docs/reference/chisel-releases/slice-definitions.md, so there is no need to repeat it. |
||
|
|
||
| </td> | ||
| </tr> | ||
|
|
@@ -69,7 +78,8 @@ 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. File ownership (UID:GID) is not preserved | ||
| during this process; the owner of all extracted files is set to the current user. | ||
|
|
||
| </td> | ||
| </tr> | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,12 +40,18 @@ A package's slices can be defined via a YAML slice definitions file. Check | |
|
|
||
| ## Naming convention | ||
|
|
||
| ### Slice naming | ||
|
|
||
| In Chisel, slices are recognized by the following pattern: | ||
| `<package_name>_<slice_name>`. | ||
|
|
||
| For example, the slice `libc6_libs` refers to the slice definition `libs` of the | ||
| package `libc6`. | ||
|
|
||
|
|
||
| The use of an underscore in this pattern is what distinguishes package names from | ||
| slice names, as this character is not allowed in Debian package names. | ||
|
|
||
| ### Package naming | ||
|
|
||
| Package names must be the same as the package names in the archive, so that | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is redundant. It's basically saying: "the package names must be the same as the package names". It might have made sense in the FAQ, but this page is about slices, and thus "naming convention" refers to the slices naming convention. There's no package naming, cause there are no packages in chisel, only references to the package a slice comes from |
||
| there's a single namespace to remember and respect. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This information is already in docs/reference/chisel-releases/index.md, there is no need to repeat it here.