summaryrefslogtreecommitdiffstats
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* docs: desaturate dark-mode background colorBenjamin Franzke2022-06-101-1/+2
| | | | | | | | | | The documentations dark-mode background color as added in #23417 was perceived to be too purple-y [1] and is therefore replaced by a desaturated black that is derived from the systemd brand-black using 12% less HSL saturation. [1] https://github.com/systemd/systemd/pull/23417#issuecomment-1146323820
* tree-wide: fix typoYu Watanabe2022-06-102-2/+2
|
* docs/AUTOMATIC_BOOT_ASSESSMENT: describe how to integrate a DE viability checkZbigniew Jędrzejewski-Szmek2022-06-091-28/+45
| | | | | | I reordered the component list to match chronological order: we first install an entry, then boot it, then the checks happen, etc. Before it was ordered by "importance", but that is harder to follow.
* docs/BLS: move "boot counting" into the main specZbigniew Jędrzejewski-Szmek2022-06-092-63/+118
| | | | | | | | | | | | | | | | | | | | | The boot-counting file-renaming entry-sorting part that the boot loader implements is moved to the main document. The second document describes a specific implementation that is provided through systemd units. The sorting algorithm is extended to say that bad entries should be sorted later. I also added a note that bad entries should be available for booting. For some reason, the second document said that it applies only to EFI systems. AFAIK there are no implementations for non-EFI, but the specification should work just fine, if somebody were to implement it. So that part is dropped. Fixes #23345. Sadly, bootctl doesn't implement sorting of boot entries with counting :(((( But I'm leaving that for another PR.
* CODING_STYLE: say that inet_ntop() is a no noZbigniew Jędrzejewski-Szmek2022-06-061-0/+5
|
* sd-bus: drop D-Bus version 2 format supportYu Watanabe2022-05-311-111/+0
| | | | It seems the format is used only by kdbus.
* docs: fix typo XBOOOTLDR -> XBOOTLDRMatthias Lisin2022-05-311-1/+1
|
* doc: fix typoYu Watanabe2022-05-301-5/+5
| | | | Follow-ups for #23504.
* docs: mention how to build 32 bit fuzz targetsEvgeny Vereshchagin2022-05-291-0/+3
|
* Merge pull request #23504 from keszybz/bls-reorderingLuca Boccassi2022-05-271-283/+456
|\ | | | | Refactor the BLS and add a description of version sorts
| * docs/BLS: clear up the confusion about what $BOOT meansZbigniew Jędrzejewski-Szmek2022-05-261-81/+84
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The text used was originally written for everything being on the ESP. It was later generalized for support XBOOTLDR, and "$BOOT" was introduced to mean something like "XBOOTLDR if present, the ESP otherwise", and most of the text was changed to talk about $BOOT. Sadly, this doesn't work, because the two partitions are not interchangeable. sd-boot loads entries from both partitions, and its configuration, random-seed, etc. only from the ESP. The terms are redefined: $BOOT now means either the ESP or the "boot partition" playing the same role on MBR systems, and $XBOOTLDR is XBOOTLDR. Like various previous commits, this makes the specification describe our current implementation. Also, the let's just accept the common practice of using /boot and /boot/efi. Since both partitions need to be read to gather configuration, it isn't a problem that one is mounted underneath the other one. I think having /boot and /efi is OK, but not better in any measureable way, so let's stop trying to push people towards this setup. A note that XBOOTLDR must be on the same disk as ESP is added.
| * docs/BLS: describe version comparisonsZbigniew Jędrzejewski-Szmek2022-05-251-10/+114
| | | | | | | | Fixes #23346.
| * docs/BLS: rework the description of directory layoutZbigniew Jędrzejewski-Szmek2022-05-241-27/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We said "`$BOOT/loader/` is the directory containing all files needed for Type #1 entries" which is blatantly wrong. And also saying that we define two directories, /loader and /loader/entries, but only ever defining the second one was not very consistent. Instead, let's say that /loader/ is for "boot loader configuration", and /loader/entries has the snippets. A new section about /<entry-token>/<version>/ is added. This is described as the "recommended layout for additional files". Also, we said that ID= should be used in the file name, but in fact it wasn't in the example that was given, and afaik, nobody ever did that. So this part is reduced to say "kernel version (as returned by `uname -r`, including the OS identifier)". AFAIK, all distros include some form of OS identifier in the version, so this should be good enough. Since we now don't depend on autodetection (e.g. with entry-token and layout configured), the installed doesn't need to always create /loader/entries and things will still work. So don't say that the installer needs to create it. Part of the discussion is moved to the Discussion section. Overall, this brings the specification more in line with actual practice.
| * docs: /etc/os-release → os-release(3)Zbigniew Jędrzejewski-Szmek2022-05-241-13/+14
| | | | | | | | It's /usr/lib/os-release now mostly. But let's link to the man page.
| * docs: reworder/rewrite BLS to read more like a specificationZbigniew Jędrzejewski-Szmek2022-05-241-229/+278
| | | | | | | | | | | | | | | | | | | | | | | | I tried not to introduce any semantic changes, but to reorder the whole text to be more usable as a reference specification: more sections are created and the discussion and justifications are moved to the end. Also, "BIOS" is changed to "firmware" in various places, and other parts of the text that made sense when this was originally written are now dated are adjusted. I separated and extended the examples a bit. The abstract at the top ("TL;DR: Currently there’s no common boot scheme…") is dropped. It didn't seem to fit anywhere.
* | docs: be more specific about the OSS-Fuzz toolchainEvgeny Vereshchagin2022-05-261-6/+20
| |
* | docs: update OSS-Fuzz linksEvgeny Vereshchagin2022-05-261-2/+5
|/
* Merge pull request #23414 from keszybz/analyze-vercmpZbigniew Jędrzejewski-Szmek2022-05-231-5/+5
|\ | | | | systemd-analyze compare-versions
| * Clean up the text in description of strverscmp_improved()Zbigniew Jędrzejewski-Szmek2022-05-171-5/+5
| |
* | docs: improve table readabilityBenjamin Franzke2022-05-211-3/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Let the table span more than the default content width, if the table contains alot of data (controlled by width: auto) (720px is very good for continuous text, but too narrow for tables). The container class is therefore adapted to put the width restriction on the elements itself, allowing for exceptions for individual elements like <table> and <h1> (which used an offset margin before and is now streamlined to use a max-width as well). Also add a striped background to ease reading rows and allow for horizontal mobile scrolling without overflowing the entire document, only the table itself.
* | Merge pull request #23460 from keszybz/docs-redirectZbigniew Jędrzejewski-Szmek2022-05-214-148/+178
|\ \ | | | | | | docs: rename COREDUMP_PACKAGE_METADATA → ELF_PACKAGE_METADATA
| * | docs: adapt forward layout to systemd.io designBenjamin Franzke2022-05-212-6/+18
| | |
| * | docs: rename COREDUMP_PACKAGE_METADATA → ELF_PACKAGE_METADATAZbigniew Jędrzejewski-Szmek2022-05-213-147/+165
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The format described by this document is used not only for coredumps, but also for other purposes, so we've outgrown the old title. A redirect was added based on https://codepo8.github.io/github-redirection-demo/. I tried to use a relative link, but it's hard to test if it works before merging. Co-authored-by: Benjamin Franzke <benjaminfranzke@googlemail.com>
* | | tree-wide: replace obsolete wiki links with systemd.io/manpagesBenjamin Franzke2022-05-211-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | All wiki pages that contain a deprecation banner pointing to systemd.io or manpages are updated to point to their replacements directly. Helpful command for identification of available links: git grep freedesktop.org/wiki | \ sed "s#.*\(https://www.freedesktop.org/wiki[^ $<'\\\")]*\)\(.*\)#\\1#" | \ sort | uniq
* | | tree-wide: streamline wiki linksBenjamin Franzke2022-05-212-3/+3
|/ / | | | | | | | | | | | | | | * Avoid traling slash as most links are defined without. * Always use https:// protocol and www. subdomain Allows for easier tree-wide linkvalidation for our migration to systemd.io.
* | docs: streamline headline structure in JOURNAL_EXPORT_FORMATS.mdBenjamin Franzke2022-05-181-3/+5
| | | | | | | | | | Add one general first-level headline and transform the existing ones into second-level headlines.
* | docs: use relative linksBenjamin Franzke2022-05-1822-100/+92
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Allows for links to work both on systemd.io (or forks) and when viewed on https://github.com/systemd/systemd/tree/main/docs Note that the markdown links are converted by jekyll-relative-links[1] to html. This plugin is enabled by default on github pages[2][3]. Due to a bug in jekyll-relative-links – see https://github.com/benbalter/jekyll-relative-links/issues/61 – we need to avoid line-wrapped links when using relative markdown links. [1] https://github.com/benbalter/jekyll-relative-links [2] https://github.blog/2016-12-05-relative-links-for-github-pages/ [3] https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins
* | Merge pull request #23417 from bnf/docs-dark-modeZbigniew Jędrzejewski-Szmek2022-05-1811-313/+484
|\ \ | | | | | | docs: add dark mode
| * | docs: overhaul styling for example log messages on startpageBenjamin Franzke2022-05-172-40/+63
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Use brand-green for demo log messages on the startpage instead of the default `green` color defined by the browser vendor (after all, the brand green color is intended to reflect the boot status output) * Add a matching blue intro color (mixed using HSL from brand-green by 55deg hue rotation and 4% lightness) * Use a defined font-size (to avoid blurry rendering at 13.33333px, due to font-size: smaller) * Add possibility for the browser to show horizontal scrollbar (avoid overflow in mobile view)
| * | docs: add dark modeBenjamin Franzke2022-05-173-223/+361
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Respect the user agent property `prefers-color-scheme` by rendering the documentation in dark mode, if requested. Reorganise CSS to store the color palette into CSS variables and reference these from another set of CSS variables that are dynamically switched based on the prefers-color-scheme media query. Light mode variables stay they same as before, but to ease color mixing, the current RGB values have been transformed to HSL (using chrome devtools). The current body background is now --sd-gray-extralight, the current body color is now --sd-gray-extradark. Other gray-variations, needed for dark-mode constrasts are derived from these colors using HSL lightness shifting. The systemd brand black color is used as dark mode background and a matching extralight gray font color has been selected. The link font-weight is reduced to 400 in dark mode, as the green color on dark ground becomes to overwhelming with a bold font. The systemd logo color is dynamically swapped by using the special fill value `currentColor` for dark/light-mode depending parts – as per specification on brand.systemd.io
| * | docs: regenerate highlight style and streamline background overwriteBenjamin Franzke2022-05-171-7/+10
| | | | | | | | | | | | | | | | | | | | | | | | * Update to rougify 3.26.1 styling * Adapt background overwrite by removing default background color and only adding explicit overwrites for syntax error (error stylings appear for example in json-excerpts – see HACKING.md – and are therefore hidden by our css)
| * | docs: avoid multiple first-level headlinesBenjamin Franzke2022-05-173-22/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One document should only contain one main headline, both for structuring and for visual reasons. Relevant cases found via: git grep -A2 '^# ' docs/
| * | docs: provide a first level headline for the frontpageBenjamin Franzke2022-05-171-0/+2
| | | | | | | | | | | | | | | | | | | | | * Provides a nice introduction to the intro paragraph * Ensures text of subpages start at the same position as the intro text on the homepage => less visual "jumps" while navigating
| * | docs: respect default browser font-sizeBenjamin Franzke2022-05-171-5/+7
| | | | | | | | | | | | | | | | | | | | | | | | 16px is default by all browser vendors when font-setting is defined to be 'medium'. Scale all font sizes and margins to based on 16px base size.
| * | docs: add reasonable difference between h2 and h3 font-sizeBenjamin Franzke2022-05-171-1/+4
| | |
| * | docs: replace <pre>, <code> and <tt> tags by backticksBenjamin Franzke2022-05-172-10/+10
| | | | | | | | | | | | | | | | | | Let jekyll render a proper codeblock, instead of using custom HTML code in markdown. Also <tt> is deprecated.
| * | docs: adapt theme color meta propertyBenjamin Franzke2022-05-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | The theme color is used on android to style the chrome browser-ui with a color that suits the webpage. Use the dark brand color instead of a random default blue color in order to fit to the rest of the color scheme.
| * | docs: remove unneeded font-related attributes from svg logoBenjamin Franzke2022-05-171-2/+2
| | | | | | | | | | | | | | | The font has been vectorized and therefore all font related properties are ignored anyway.
| * | docs: use whole numbers for circle in page-logoBenjamin Franzke2022-05-171-1/+1
| | | | | | | | | | | | | | | 0.001 is usually rounded to 0 by browsers, still, better to be explicit and save some bytes.
| * | docs: replace invalid h1 font-weightBenjamin Franzke2022-05-171-1/+1
| | | | | | | | | | | | | | | | | | | | | h1 font weight is defined to be 100 but no font-face definition for weight 100 is included. The browser will use the nearest available font-weight instead. As that is 400, we do specify it explicitly now.
| * | docs: remove link to missing apple-touch-iconBenjamin Franzke2022-05-171-1/+0
| | |
| * | docs: remove invalid link to feed.xmlBenjamin Franzke2022-05-171-1/+0
| | |
| * | docs: remove trailing spaceBenjamin Franzke2022-05-172-3/+3
| | |
* | | doc: fix typoYu Watanabe2022-05-181-3/+3
|/ /
* | docs: say how to delay network-online.targetZbigniew Jędrzejewski-Szmek2022-05-171-0/+35
| | | | | | | | | | | | Could be related to https://access.redhat.com/solutions/4879291. Unfortunately I can't access this page, but the title seems relevant.
* | docs: copy the page about network-online.target from the wikiZbigniew Jędrzejewski-Szmek2022-05-171-0/+226
|/ | | | | | | | | | | | | | | | | | | | From https://www.freedesktop.org/wiki/Software/systemd/NetworkTarget/. I changed the order in the page, but didn't change the text too much. Now the discussion of the different targets is at the top, and they are ordered like during boot (network-pre.target first, then network.target, and network-online.target last). The parts about LSB and $network are pushed down a bit. I think it is still useful to have them, but not as the main entry point into the discussion. I tried to clean up the grammar and wording a bit. One meanigful change is that we now don't say that network-online.target means interfaces are up and IP addresses have been assigned. In other places we were saying that the actual implementation is provided by NetworkManager-wait-online.service, so the actual meaning is not under our control. The text is changed to say "usually". The last paragraph is new, I think it's good to say that "dnf-makecache.service" is fine to use "network-online.target".
* fix typoStefan Seering2022-05-121-1/+1
|
* Use consistent formatting for `PID 1` across `docs/`Elias Probst2022-05-113-4/+4
|
* Typo (`swich-root` → `switch-root`)Elias Probst2022-05-111-1/+1
|
* docs/ARCHITECTURE: describe fuzzer locations and useZbigniew Jędrzejewski-Szmek2022-05-081-1/+16
|