summaryrefslogtreecommitdiff
path: root/docs/BOOT_LOADER_SPECIFICATION.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: make man page links in markdown Links section use teletype font, as we ↵Lennart Poettering2022-03-231-3/+3
| | | | usually do
* docs: add /loader/entries.srel to the boot loader specLennart Poettering2022-03-221-0/+12
| | | | | | | | | | | This new file is supposed to address conflicts with Fedora/Grub's frankenbootloaderspec implementation, that squatted the /loader/entries/ dir, but place incompatible files in them (that do variable expansion?). A simple text file /loader/entries.srel shall indicate which spec is implemented. If it contains the string "type1\n" then the /loader/entries/ directory implements our standard spec, otherwise something else.
* docs: add new "sort-key" field to boot loader specLennart Poettering2022-03-181-5/+16
| | | | | | | | | | | | | | | | | | | | | | This allows snippet generators to explicitly order entries: any string can be set as an entry's "sort key". If set, sd-boot will use it to sort entries on display. New logic is hence (ignore the boot counting logic) sort-key is set → primary sort key: sort-key (lexicographically increasing order) → secondary sort key: machine-id (also increasing order) → tertiary sort key: version (lexicographically decreasing order!) sort-key is not set → primary sort key: entry filename (aka id), lexicographically increasing order) With this scheme we can order OSes by their names from A-Z but then put within the same OS still the newest version first. This should clean up the order to match expectations more. Based on discussions here: https://github.com/systemd/systemd/pull/22391#issuecomment-1040092633
* doc: rebreak boot loader specLennart Poettering2021-11-191-66/+225
|
* docs: add spdx tags to all .md filesZbigniew Jędrzejewski-Szmek2021-09-271-0/+1
| | | | | | I have no idea if this is going to cause rendering problems, and it is fairly hard to check. So let's just merge this, and if it github markdown processor doesn't like it, revert.
* docs: improve wording when mentioning the acronym "ESP"nl67202021-07-091-2/+2
| | | | "ESP" is "EFI system partition", so "ESP partition" is redundant.
* docs: EFI separator needs to be backslash-escaped in markdownJuergen Hoetzel2021-06-241-1/+1
|
* docs: use current spelling "macOS" not "OS X" etc.Carlo Teubner2021-04-021-1/+1
|
* tree-wide: fix typos found by Fossies codespell reportYu Watanabe2020-10-241-1/+1
|
* doc: document charset to use for bootspec entry namesLennart Poettering2020-10-191-1/+21
| | | | Prompted-by: https://github.com/systemd/systemd/issues/12572#issuecomment-711074702
* tree: wide "the the" and other trivial grammar fixesZbigniew Jędrzejewski-Szmek2020-07-021-1/+1
|
* tree-wide: fix spelling errorsFrantisek Sumsal2020-04-211-1/+1
| | | | | | Based on a report from Fossies.org using Codespell. Followup to #15436
* docs: interlink the docs to make it easier to navigateZbigniew Jędrzejewski-Szmek2020-02-281-1/+5
|
* docs: say XBOOTLDR instead of just giving the GPT identifierZbigniew Jędrzejewski-Szmek2020-02-281-8/+8
| | | | | | | Fixes #14832. Also, say "MBR partition table" and not "MBR disk label". "disk label" doesn't seem to mean anything.
* fix erroneous "`" in boot loader specAshley Davis2020-01-291-1/+1
|
* docs: clarify that we don't want to own $BOOT exclusivelyLennart Poettering2020-01-171-0/+14
| | | | | | Let's be clearer here. Prompted by a quick discussion I had with @gicmo.
* docs: drop "The" in categorization titles of Markdown documentationLennart Poettering2020-01-141-1/+1
| | | | | | | | | I think it makes sense to keep the "The" in place for the actual page's title, but let's drop it from the categorization header, to make it easier to find stuff, as the "The" isn't helpful to that. In particular as we sometimes do it this and sometimes the other way so far, hence let's stick to one common rule.
* docs: make it prettyTobias Bernard2019-12-111-0/+1
| | | | | | | Add custom Jekyll theme, logo, webfont and .gitignore FIXME: the markdown files have some H1 headers which need to be replaced with H2
* docs: place all our markdown docs in rough categoriesLennart Poettering2019-12-111-0/+1
|
* boot-loader-spec: add devicetree-overlay keyMichael Tretter2019-10-291-0/+6
| | | | | | | | | | | | | Device tree overlays are a convenient way to patch device trees, e.g., add new devices to a device tree or enable/disable devices. This is useful for non-discoverable but configurable hardware. Device tree overlays are commonly used for displays on the Raspberry Pi or for describing the content of FPGA bitstreams. Add the devicetree-overlay key to boot loader specification entries to allow boot loaders to apply overlays. See #13537
* docs: adjust the spec a bit with firmware authros in mindLennart Poettering2019-03-141-7/+36
| | | | | | | | This borrows heavily from Nico Huber's https://github.com/systemd/systemd/pull/10398, but makes a number of changes. Replaces: #10398
* xbootldr: multiple spaces between keys and values (#11872)Ben Iofel2019-03-031-1/+1
| | | The example below the changed line has multiple spaces between e.g. `title` and `Fedora`
* docs: enclose all uuids in ``Lennart Poettering2019-03-011-3/+3
|
* docs: add a "front matter" snippet to our markdown pagesFilipe Brandenburger2019-01-021-0/+4
| | | | | | | | | | | | | | | | It turns out Jekyll (the engine behind GitHub Pages) requires that pages include a "Front Matter" snippet of YAML at the top for proper rendering. Omitting it will still render the pages, but including it opens up new possibilities, such as using a {% for %} loop to generate index.md instead of requiring a separate script. I'm hoping this will also fix the issue with some of the pages (notably CODE_OF_CONDUCT.html) not being available under systemd.io Tested locally by rendering the website with Jekyll. Before this change, the *.md files were kept unchanged (so not sure how that even works?!), after this commit, proper *.html files were generated from it.
* Fix a few docs typos (#10907)nikolas2018-11-241-1/+1
| | | Found with [codespell](https://github.com/codespell-project/codespell)
* boot-loader-spec: drop link to obsolete patchLennart Poettering2018-10-191-2/+0
| | | | This is not what distros use, let's not point users to obsolete stuff.
* boot-loader-spec: elaborate on 'architecture' stanza a bit and use it in the ↵Lennart Poettering2018-10-191-7/+8
| | | | example
* docs: tweaks to the boot loader specLennart Poettering2018-10-191-17/+61
| | | | | | | | | | | | | | | | | | | | | | A couple of changes: 1. Clearly name the drop-in entry files "Type #1", and the unified kernel images "Type #2", and be clearer that the latter is specific to UEFI. 2. Suffix all directory paths with a trailing "/" to clarify that these are directories. Also, enclose them all in ``. 3. Add introductory paragraph that explains that there is Type #1 and Type #2 and what they are about. 4. Explain that Type #2 is about signed UEFI SecureBoot. 5. Don't claim that $BOOT/loader/ contains really all files defined by the spec, because that's not true, Type #2 images are not located there after all. Fixes: #10399
* docs: move doc/ to docs/Filipe Brandenburger2018-09-081-0/+140
The docs/ directory is special in GitHub, since it can be used to serve GitHub Pages from, so there's a benefit to switching to it in order to expose it directly as a website. Updated references to it from the documentations themselves, from the CONTRIBUTING.md file and from Meson build files.
View Lorry Controller Status