Skip to content

Commit

Permalink
DDI: change suffix to .gpt
Browse files Browse the repository at this point in the history
Follow-up to 68dd1d9:
the extension ".raw" is not ideal:
- it is too generic: there are simply too many things which are "raw",
  and different people will have different expectations, and an
  extension should be unique.
- a DDI is not actually "raw". It has a header with a partition table,
  so it's a well-defined binary container format. "Raw" would normally
  be used for file with just contains unadorned data, without a header
  or other means of understanding the contents without context. Once
  you take the exact same data, but wrap a header around it that
  describes the data, the file contents are not "raw".

Semantic Line Breaks à la https://sembr.org/ are used.
  • Loading branch information
keszybz committed Nov 17, 2023
1 parent 40c82a4 commit 8cf1c9d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
16 changes: 9 additions & 7 deletions specs/discoverable_disk_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,18 @@ or 4096, as per GPT specification.

## Naming

DDIs should use `.raw` as file suffix. A secondary suffix may be used to clarify the specific usage class of
a DDI. For now the two secondary suffixes `.sysext.raw` and `.confext.raw` are defined (for system extension
DDIs and configuration extension DDIs, see [Extension
Images](https://uapi-group.org/specifications/specs/extension_image) for details).
DDIs should use `.gpt` as file suffix.
A secondary suffix may be used to clarify the specific usage class of a DDI.
For now the two secondary suffixes `.sysext.gpt` and `.confext.gpt` are defined
(for system extension DDIs and configuration extension DDIs, see
[Extension Images](https://uapi-group.org/specifications/specs/extension_image)
for details).

The MIME type for DDIs is `application/vnd.efi.img`, [as per
IANA](https://www.iana.org/assignments/media-types/application/vnd.efi.img).

## Image Version
If the DDI is versioned, the version format described in the
[Version Format Specification](version_format_specification.md) must be used. The underscore character (`_`)
must be used to separate the version from the name of the image. For example: `foo_1.2.raw` denotes a `foo`
DDI with version `1.2`.
[Version Format Specification](version_format_specification.md) must be used.
The underscore character (`_`) must be used to separate the version from the name of the image.
For example: `foo_1.2.gpt` denotes a `foo` DDI with version `1.2`.
7 changes: 4 additions & 3 deletions specs/extension_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ Extension Images should be additive, and not override content present in the bas
but this will not be enforced.

## File Suffix
Since extensions images are DDIs, they should carry the `.raw` suffix. In order to make discerning system
extensions and configuration extensions easy it is recommended to use the `.sysext.raw` suffix for system
extensions, and `.confext.raw` for configuration extensions.
Since extension images are DDIs, they should also carry the `.gpt` suffix.
In order to make discerning system extensions and configuration extensions easy
it is recommended to use the `.sysext.gpt` suffix for system extensions,
and `.confext.gpt` for configuration extensions.

## Identification
An Extension Image must contain a `extension-release.<IMAGE>` file, where `<IMAGE>` must either match the
Expand Down

0 comments on commit 8cf1c9d

Please sign in to comment.