Skip to content

Cosmetic changes #204

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.

Sign up for GitHub

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

Merged
Foxboron merged 5 commits into from
Dec 23, 2025
Merged

Cosmetic changes #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
35f9795
readme: switch minus to en dash
behrmann Dec 23, 2025
caba018
specs: format markdown tables
behrmann Dec 23, 2025
193338b
vmclock: reformat structure fields table as HTML
behrmann Dec 23, 2025
ae5e04b
tpm pcr registry: remove strong markup from table headers
behrmann Dec 23, 2025
79d0bbe
gitignore: add public/
behrmann Dec 23, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
website/public
website/.hugo_build.lock
website/resources/_gen
public/
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ This section clarifies on terms and abbreviations used in specs and other docume
- [*DPS*](specs/discoverable_partitions_specification.md) - Discovery Partition Specification
- [*sysext*](specs/extension_image.md) – System Extension Image
(type of DDI that is overlayed on top of `/usr/` and `/opt/` via overlayfs and can extend the underlying OS vendor resources in a composable, immutable fashion)
- [*UKI*](specs/unified_kernel_image.md) - Unified Kernel Images (UEFI boot stub + kernel + initrd + more)
- [*UKI*](specs/unified_kernel_image.md) – Unified Kernel Images (UEFI boot stub + kernel + initrd + more)
- [*VMClock*](specs/vmclock.md) – Virtual Machine Clock (efficient time synchronisation for virtual machines)
- [*VMGenID*](specs/vmgenid.md) – Virtual Machine Generation ID (mechanism for detecting VM rollback events)
- [*VOA*](specs/file_hierarchy_for_the_verification_of_os_artifacts.md) – Verification of OS Artifacts
Expand Down
4 changes: 2 additions & 2 deletions specs/boot_loader_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.1 The Boot Loader Specification

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

This document defines a set of file formats and naming conventions that allow
Expand Down
4 changes: 2 additions & 2 deletions specs/configuration_files_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ aliases:

# UAPI.6 Configuration Files Specification

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

## Introduction
Expand Down
4 changes: 2 additions & 2 deletions specs/discoverable_disk_image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:
---
# UAPI.3 Discoverable Disk Images (DDI)

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

DDIs (Discoverable Disk Images) are self-describing file system images that follow the DPS ([Discoverable
Expand Down
4 changes: 2 additions & 2 deletions specs/discoverable_partitions_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:
---
# UAPI.2 The Discoverable Partitions Specification (DPS)

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

_TL;DR: Let's automatically discover, mount and enable the root partition,
Expand Down
4 changes: 2 additions & 2 deletions specs/elf_dlopen_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.12 `dlopen()` Metadata for ELF Files

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

## Target Audience
Expand Down
76 changes: 38 additions & 38 deletions specs/extension_image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:
---
# UAPI.4 Extension Images

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

Extension Images are DDIs ([Discoverable Disk Images](discoverable_disk_image.md)) that are
Expand Down Expand Up @@ -207,39 +207,39 @@ incompatible host from loading it.

Valid values:

|Architecture|
|------------|
|x86|
|x86-64|
|alpha|
|arc|
|arc-be|
|arm|
|arm-be|
|arm64|
|arm64-be|
|cris|
|ia64|
|loongarch64|
|m68k|
|mips|
|mips-le|
|mips64|
|mips64-le|
|parisc|
|parisc64|
|ppc|
|ppc-le|
|ppc64|
|ppc64-le|
|riscv32|
|riscv64|
|s390|
|s390x|
|sh|
|sh64|
|sparc64|
|sparc|
|tilegx|
|native|
|any|
| Architecture |
|--------------|
| x86 |
| x86-64 |
| alpha |
| arc |
| arc-be |
| arm |
| arm-be |
| arm64 |
| arm64-be |
| cris |
| ia64 |
| loongarch64 |
| m68k |
| mips |
| mips-le |
| mips64 |
| mips64-le |
| parisc |
| parisc64 |
| ppc |
| ppc-le |
| ppc64 |
| ppc64-le |
| riscv32 |
| riscv64 |
| s390 |
| s390x |
| sh |
| sh64 |
| sparc64 |
| sparc |
| tilegx |
| native |
| any |
4 changes: 2 additions & 2 deletions specs/file_hierarchy_for_the_verification_of_os_artifacts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.11 File Hierarchy for the Verification of OS Artifacts (VOA)

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|------------------|
| 0.1 | Work in progress |

## Motivation
Expand Down
4 changes: 2 additions & 2 deletions specs/linux_file_system_hierarchy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.9 Linux File System Hierarchy

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|------------------|
| 0.1 | Work in progress |

## Description
Expand Down
16 changes: 8 additions & 8 deletions specs/linux_tpm_pcr_registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ aliases:

# 🔏 UAPI.7 Linux TPM PCR Registry 🗒️

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

_TPM PCRs are a scarce resource, there are only 24 of them in typical standards compliant TPMs.
Expand Down Expand Up @@ -73,12 +73,12 @@ In both cases it is important that data measured into the PCRs is carefully chos

<table style="width:100%; display:block; table-layout:fixed;">
<tr>
<th><p style="text-align: right"><strong>PCR#</strong></p></th>
<th><strong>Used by</strong></th>
<th><strong>From Location</strong></th>
<th><strong>Measured Objects</strong></th>
<th><strong>Log</strong></th>
<th><strong>Use Reported By</strong></th>
<th><p style="text-align: right">PCR#</p></th>
<th>Used by</th>
<th>From Location</th>
<th>Measured Objects</th>
<th>Log</th>
<th>Use Reported By</th>
</tr>

<tr>
Expand Down
48 changes: 24 additions & 24 deletions specs/osc_context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.15 OSC 3008: Hierarchical Context Signalling

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial release |

A terminal connects a user with programs. Control of the program side of
Expand Down Expand Up @@ -155,31 +155,31 @@ the start sequence. The sequence ends in ST.

The following fields are currently defined for the start sequence:

| Field | Context Types | Description |
|---------------|---------------|-------------------------------------------------------------------------------------------------------------|
| `type=` | *all* | Declares the context type, one of the types described above |
| `user=` | *all* | UNIX user name the process issuing the sequence runs as |
| `hostname=` | *all* | UNIX host name of the system the process issuing the sequence runs on |
| `machineid=` | *all* | The machine ID (i.e. `/etc/machine-id`) of the system the process issuing the sequence runs on |
| `bootid=` | *all* | The boot ID (i.e. `/proc/sys/kernel/random/boot_id`) of the system the process issuing the sequence runs on |
| `pid=` | *all* | The numeric PID of the process issuing the sequence, in decimal notation |
| `pidfdid=` | *all* | The 64bit inode number of the pidfd of the process issuing the sequence, in decimal notation |
| `comm=` | *all* | The process name (i.e. `/proc/$PID/comm`, `PR_GET_NAME`) of the process issuing the sequence |
| `cwd=` | `shell`, `command` | The current working directory |
| `cmdline=` | `command` | The full command line of the invoked command |
| `vm=` | `vm` | The name of the VM being invoked |
| `container=` | `container` | The name of the container being invoked |
| `targetuser=` | `elevate`, `chpriv`, `vm`, `container`, `remote`, `session` | Target UNIX user name |
| `targethost=` | `remote` | Target UNIX, DNS host name, or IP address |
| `sessionid=` | `session` | New allocated session ID |
| Field | Context Types | Description |
|---------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| `type=` | *all* | Declares the context type, one of the types described above |
| `user=` | *all* | UNIX user name the process issuing the sequence runs as |
| `hostname=` | *all* | UNIX host name of the system the process issuing the sequence runs on |
| `machineid=` | *all* | The machine ID (i.e. `/etc/machine-id`) of the system the process issuing the sequence runs on |
| `bootid=` | *all* | The boot ID (i.e. `/proc/sys/kernel/random/boot_id`) of the system the process issuing the sequence runs on |
| `pid=` | *all* | The numeric PID of the process issuing the sequence, in decimal notation |
| `pidfdid=` | *all* | The 64bit inode number of the pidfd of the process issuing the sequence, in decimal notation |
| `comm=` | *all* | The process name (i.e. `/proc/$PID/comm`, `PR_GET_NAME`) of the process issuing the sequence |
| `cwd=` | `shell`, `command` | The current working directory |
| `cmdline=` | `command` | The full command line of the invoked command |
| `vm=` | `vm` | The name of the VM being invoked |
| `container=` | `container` | The name of the container being invoked |
| `targetuser=` | `elevate`, `chpriv`, `vm`, `container`, `remote`, `session` | Target UNIX user name |
| `targethost=` | `remote` | Target UNIX, DNS host name, or IP address |
| `sessionid=` | `session` | New allocated session ID |

The following fields are currently defined for the end sequence:

| Field | Context Types | Description |
|---------------|---------------|-------------------------------------------------------------------------------------------------------------|
| `exit=` | `command` | One of `success`, `failure`, `crash`, `interrupt`, indicating how the program terminated |
| `status=` | `command` | The command's numeric exit status, i.e. the 0…255 value a program returns |
| `signal=` | `command` | The termination signal of the command, if it died abnormally. A symbolic signal name. (`SIGKILL`, …) |
| Field | Context Types | Description |
|-----------|---------------|------------------------------------------------------------------------------------------------------|
| `exit=` | `command` | One of `success`, `failure`, `crash`, `interrupt`, indicating how the program terminated |
| `status=` | `command` | The command's numeric exit status, i.e. the 0…255 value a program returns |
| `signal=` | `command` | The termination signal of the command, if it died abnormally. A symbolic signal name. (`SIGKILL`, …) |

All fields are optional, including the context type. However, it is generally
recommended to always include the first 7 fields listed above, to make it easy
Expand Down
4 changes: 2 additions & 2 deletions specs/package_metadata_for_executable_files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ aliases:

# UAPI.8 Package Metadata for Executable Files

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

## Target Audience
Expand Down
4 changes: 2 additions & 2 deletions specs/unified_kernel_image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:
---
# UAPI.5 Unified Kernel Images (UKI)

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

A Unified Kernel Image (UKI) is a combination of an UEFI boot stub program,
Expand Down
4 changes: 2 additions & 2 deletions specs/version_format_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:

# UAPI.10 Version Format Specification

| Version | Changes |
|---------|---------|
| Version | Changes |
|---------|-----------------|
| 1.0 | Initial Release |

This specification defines the format of version strings and their ordering.
Expand Down
Loading