summaryrefslogtreecommitdiffstats
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* docs: use Title Case for section titlesLennart Poettering2022-08-291-7/+7
| | | | | | as per: https://titlecase.com/
* docs: fix incorrect env var name for credentials directoryUriel Corfa2022-08-281-2/+2
| | | | | CREDENTIAL_PATH appears nowhere in the systemd source code. $CREDENTIALS_DIRECTORY is what is used instead.
* resolve: control system hostname synthesis via environment variableJacek Migacz2022-08-261-0/+5
|
* docs: suggests people use path_extract_filename() + path_extract_directory()Lennart Poettering2022-08-231-5/+5
|
* docs: Add guide to debug binaries in vscode that need to run as rootDaan De Meyer2022-08-181-0/+24
|
* docs: Recommend pkexec over using an askpass program with sudoDaan De Meyer2022-08-181-7/+4
| | | | | Less configuration required than downloading and configuring an askpass program.
* docs: mention qemu fw_cfg size limitationLudwig Nussel2022-08-111-1/+2
|
* docs: mkosi-13 or newer requiredSonali Srivastava2022-08-081-4/+5
|
* docs: add disabled PR template for code freezeLuca Boccassi2022-08-041-10/+12
| | | | | | To be enabled on rc1, and disabled again after the final release. Gives contributors a clear warning that new features/APIs will be postponed.
* mkosi: Remove usage of deprecated option names/sectionsDaan De Meyer2022-07-181-3/+3
|
* mkosi: Changes to allow booting with sanitizers in mkosiDaan De Meyer2022-07-182-0/+21
| | | | | | | | | | | | - Extra memory because ASAN needs it - The environment variables to make the sanitizers more useful - LD_PRELOAD because the ASAN DSO needs to be the first in the list - The sanitizer library packages - Disable syscall filters because they interfere with ASAN - Disable systemd-hwdb-update because it's super slow when systemd-hwdb is built with sanitizers - Take the value for meson's b_sanitize option from the SANITIZERS environment variable
* Merge pull request #24018 from keszybz/generator-cleanupsYu Watanabe2022-07-151-0/+3
|\ | | | | Make generators easier to test, fix various corner issues
| * fstab-generator: allow overriding path to /sysroot/etc/fstab tooZbigniew Jędrzejewski-Szmek2022-07-151-0/+3
| | | | | | | | This adds $SYSTEMD_SYSROOT_FSTAB analoguous to $SYSTEMD_FSTAB.
* | pid1: add mechanism for conditionalizing units/network/netdev/link based on ↵Lennart Poettering2022-07-151-0/+6
| | | | | | | | | | | | | | credentials passed in This is useful when provisioning systems via nspawn/qemu and running specific services only if specific data is passed into the system.
* | pid1: import creds from SMBIOS too, not just qemu's fw_cfgLennart Poettering2022-07-151-10/+19
|/ | | | | | | | | | | | | | | | | | | | | | | | | This imports credentials also via SMBIOS' "OEM vendor string" section, similar to the existing import logic from fw_cfg. Functionality-wise this is very similar to the existing fw_cfg logic, both of which are easily settable on the qemu command line. Pros and cons of each: SMBIOS OEM vendor strings: - pro: fast, because memory mapped - pro: somewhat VMM independent, at least in theory - pro: qemu upstream sees this as the future - pro: no additional kernel module needed - con: strings only, thus binary data is base64 encoded fw_cfg: - pro: has been supported for longer in qemu - pro: supports binary data - con: slow, because IO port based - con: only qemu - con: requires qemu_fw_cfg.ko kernel module - con: qemu upstream sees this as legacy
* docs: normalize uppercasing of titles of network docLennart Poettering2022-07-051-1/+1
|
* docs: move some stuff into "Networking" sectionLennart Poettering2022-07-052-2/+2
| | | | | | The "Networking" section has a lonely single document listed right now, even though the "Concepts" section has two more network related docs. Move them over, let's end this loneliness.
* tree-wide: link to docs.kernel.org for kernel documentationnl67202022-07-041-1/+1
| | | | | | | https://www.kernel.org/ links to https://docs.kernel.org/ for the documentation. See https://git.kernel.org/pub/scm/docs/kernel/website.git/commit/?id=ebc1c372850f249dd143c6d942e66c88ec610520 These URLs are shorter and nicer looking.
* docs/ARCHITECTURE: mention src/fundamental/ and add more detailsZbigniew Jędrzejewski-Szmek2022-06-301-16/+46
|
* Merge pull request #23849 from mbiebl/more-httpsYu Watanabe2022-06-289-28/+28
|\ | | | | Use https for freedesktop.org
| * Use https for man7.orgMichael Biebl2022-06-288-23/+23
| |
| * Use https for freedesktop.orgMichael Biebl2022-06-281-5/+5
| | | | | | | | grep -l -r http:// | xargs sed -E -i s'#http://(.*).freedesktop.org#https://\1.freedesktop.org#'
* | gpt: add PARISC UUIDsSam James2022-06-281-0/+6
|/ | | | Not doing PARISC64 for now as no userland exists for it yet.
* docs/CONTRIBUTING: ask people to send a ping on stalled reviewsZbigniew Jędrzejewski-Szmek2022-06-101-2/+3
| | | | | | | | | | | | | | A few related changes: be explicit that 'main' is the branch we're referring to. There was a case recently of somebody rebasing on 'master' by mistake. It's better to be explicit, since 'main' is still not the default for git (AFAIK). Also, github seems to send mails about force-pushes, so drop that as a justification. Commenting about changes that were done is useful even if github were to send a notification. And finally, $subject. We do that ourselves, but outside contributors might not know that that's expected.
* 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.