diff --git a/README.md b/README.md index b3bcf9ed94..c4522a2bac 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,13 @@ Information about build requirements is provided in the [README file](README). Consult our [NEWS file](NEWS) for information about what's new in the most recent systemd versions. -Please see the [Code Map](docs/_contributing/ARCHITECTURE.md) for information about this repository's layout and content. +Please see the [Code Map](docs/ARCHITECTURE.md) for information about this repository's layout and content. -Please see the [Hacking guide](docs/_contributing/HACKING.md) for information on how to hack on systemd and test your modifications. +Please see the [Hacking guide](docs/HACKING.md) for information on how to hack on systemd and test your modifications. -Please see our [Contribution Guidelines](docs/_contributing/CONTRIBUTING.md) for more information about filing GitHub Issues and posting GitHub Pull Requests. +Please see our [Contribution Guidelines](docs/CONTRIBUTING.md) for more information about filing GitHub Issues and posting GitHub Pull Requests. -When preparing patches for systemd, please follow our [Coding Style Guidelines](docs/_contributing/CODING_STYLE.md). +When preparing patches for systemd, please follow our [Coding Style Guidelines](docs/CODING_STYLE.md). If you are looking for support, please contact our [mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel), join our [IRC channel #systemd on libera.chat](https://web.libera.chat/#systemd) or [Matrix channel](https://matrix.to/#/#systemd-project:matrix.org) diff --git a/docs/_userdocs/API_FILE_SYSTEMS.md b/docs/API_FILE_SYSTEMS.md similarity index 99% rename from docs/_userdocs/API_FILE_SYSTEMS.md rename to docs/API_FILE_SYSTEMS.md index a7e350b7aa..84a1900e41 100644 --- a/docs/_userdocs/API_FILE_SYSTEMS.md +++ b/docs/API_FILE_SYSTEMS.md @@ -50,4 +50,3 @@ You have three options: 1. Disable any mounting on `/tmp` so that it resides on the same physical file system as the root directory. For that, execute `systemctl mask tmp.mount` 2. Mount a different, physical file system to `/tmp`. For that, simply create an entry for it in `/etc/fstab` as you would do for any other file system. 3. Keep `/tmp` but increase/decrease the size of it. For that, also just create an entry for it in `/etc/fstab` as you would do for any other `tmpfs` file system, and use the right `size=` option. - diff --git a/docs/_contributing/ARCHITECTURE.md b/docs/ARCHITECTURE.md similarity index 100% rename from docs/_contributing/ARCHITECTURE.md rename to docs/ARCHITECTURE.md diff --git a/docs/_booting/AUTOMATIC_BOOT_ASSESSMENT.md b/docs/AUTOMATIC_BOOT_ASSESSMENT.md similarity index 100% rename from docs/_booting/AUTOMATIC_BOOT_ASSESSMENT.md rename to docs/AUTOMATIC_BOOT_ASSESSMENT.md diff --git a/docs/_devdocs/AUTOPKGTEST.md b/docs/AUTOPKGTEST.md similarity index 100% rename from docs/_devdocs/AUTOPKGTEST.md rename to docs/AUTOPKGTEST.md diff --git a/docs/_devdocs/BACKPORTS.md b/docs/BACKPORTS.md similarity index 100% rename from docs/_devdocs/BACKPORTS.md rename to docs/BACKPORTS.md diff --git a/docs/_interfaces/BLOCK_DEVICE_LOCKING.md b/docs/BLOCK_DEVICE_LOCKING.md similarity index 100% rename from docs/_interfaces/BLOCK_DEVICE_LOCKING.md rename to docs/BLOCK_DEVICE_LOCKING.md diff --git a/docs/_devdocs/BOOT.md b/docs/BOOT.md similarity index 99% rename from docs/_devdocs/BOOT.md rename to docs/BOOT.md index 98bcc2ef3d..574cc080cf 100644 --- a/docs/_devdocs/BOOT.md +++ b/docs/BOOT.md @@ -109,4 +109,3 @@ Links: [https://github.com/systemd/systemd](https://github.com/systemd/systemd) [http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/](http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/) - diff --git a/docs/_booting/BOOT_LOADER_INTERFACE.md b/docs/BOOT_LOADER_INTERFACE.md similarity index 100% rename from docs/_booting/BOOT_LOADER_INTERFACE.md rename to docs/BOOT_LOADER_INTERFACE.md diff --git a/docs/_booting/BOOT_LOADER_SPECIFICATION.md b/docs/BOOT_LOADER_SPECIFICATION.md similarity index 100% rename from docs/_booting/BOOT_LOADER_SPECIFICATION.md rename to docs/BOOT_LOADER_SPECIFICATION.md diff --git a/docs/_concepts/BUILDING_IMAGES.md b/docs/BUILDING_IMAGES.md similarity index 100% rename from docs/_concepts/BUILDING_IMAGES.md rename to docs/BUILDING_IMAGES.md diff --git a/docs/_devdocs/CATALOG.md b/docs/CATALOG.md similarity index 99% rename from docs/_devdocs/CATALOG.md rename to docs/CATALOG.md index fa5e7b091e..bcbf5b90bc 100644 --- a/docs/_devdocs/CATALOG.md +++ b/docs/CATALOG.md @@ -65,4 +65,3 @@ To add message catalog entries for log messages your application generates, plea * Use the [native Journal logging APIs](http://0pointer.de/blog/projects/journal-submit.html) to generate your messages, and define message IDs for all messages you want to add catalog entries for. You may use `journalctl --new-id128` to allocate new message IDs. * Write a catalog entry file for your messages and ship them in your package and install them to `/usr/lib/systemd/catalog/` (if you package your software with RPM use `%_journalcatalogdir`) * Ensure that after installation of your application's RPM/DEB "`journalctl --update-catalog`" is executed, in order to update the binary catalog index. (if you package your software with RPM use the `%journal_catalog_update` macro to achieve that.) - diff --git a/docs/_interfaces/CGROUP_DELEGATION.md b/docs/CGROUP_DELEGATION.md similarity index 100% rename from docs/_interfaces/CGROUP_DELEGATION.md rename to docs/CGROUP_DELEGATION.md diff --git a/docs/_contributing/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from docs/_contributing/CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/docs/_contributing/CODE_QUALITY.md b/docs/CODE_QUALITY.md similarity index 100% rename from docs/_contributing/CODE_QUALITY.md rename to docs/CODE_QUALITY.md diff --git a/docs/_contributing/CODING_STYLE.md b/docs/CODING_STYLE.md similarity index 100% rename from docs/_contributing/CODING_STYLE.md rename to docs/CODING_STYLE.md diff --git a/docs/_interfaces/CONTAINER_INTERFACE.md b/docs/CONTAINER_INTERFACE.md similarity index 100% rename from docs/_interfaces/CONTAINER_INTERFACE.md rename to docs/CONTAINER_INTERFACE.md diff --git a/docs/_contributing/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from docs/_contributing/CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/docs/_devdocs/CONTROL_GROUP_INTERFACE.md b/docs/CONTROL_GROUP_INTERFACE.md similarity index 100% rename from docs/_devdocs/CONTROL_GROUP_INTERFACE.md rename to docs/CONTROL_GROUP_INTERFACE.md diff --git a/docs/_groups/CONVERTING_TO_HOMED.md b/docs/CONVERTING_TO_HOMED.md similarity index 100% rename from docs/_groups/CONVERTING_TO_HOMED.md rename to docs/CONVERTING_TO_HOMED.md diff --git a/docs/_concepts/COREDUMP.md b/docs/COREDUMP.md similarity index 100% rename from docs/_concepts/COREDUMP.md rename to docs/COREDUMP.md diff --git a/docs/_concepts/CREDENTIALS.md b/docs/CREDENTIALS.md similarity index 100% rename from docs/_concepts/CREDENTIALS.md rename to docs/CREDENTIALS.md diff --git a/docs/_userdocs/DAEMON_SOCKET_ACTIVATION.md b/docs/DAEMON_SOCKET_ACTIVATION.md similarity index 99% rename from docs/_userdocs/DAEMON_SOCKET_ACTIVATION.md rename to docs/DAEMON_SOCKET_ACTIVATION.md index 797deaefd0..1a027a37c8 100644 --- a/docs/_userdocs/DAEMON_SOCKET_ACTIVATION.md +++ b/docs/DAEMON_SOCKET_ACTIVATION.md @@ -120,4 +120,3 @@ It's possible to shut down the service and re-activate it using the web browser, sudo systemctl stop my-php-fpm-pool.socket my-php-fpm-pool.service sudo systemctl start my-php-fpm-pool.socket ``` - diff --git a/docs/_userdocs/DEBUGGING.md b/docs/DEBUGGING.md similarity index 99% rename from docs/_userdocs/DEBUGGING.md rename to docs/DEBUGGING.md index 1d3d829a3f..dc1c8743b4 100644 --- a/docs/_userdocs/DEBUGGING.md +++ b/docs/DEBUGGING.md @@ -209,4 +209,3 @@ Whenever possible, the following should be mentioned and attached to your bug re * ideally after booting with `systemd.log_level=debug systemd.log_target=kmsg log_buf_len=1M printk.devkmsg=on` * The output of a systemd dump: `systemd-analyze dump > systemd-dump.txt` * The output of `/usr/lib/systemd/systemd --test --system --log-level=debug > systemd-test.txt 2>&1` - diff --git a/docs/_concepts/DESKTOP_ENVIRONMENTS.md b/docs/DESKTOP_ENVIRONMENTS.md similarity index 100% rename from docs/_concepts/DESKTOP_ENVIRONMENTS.md rename to docs/DESKTOP_ENVIRONMENTS.md diff --git a/docs/_concepts/DISTRO_PORTING.md b/docs/DISTRO_PORTING.md similarity index 100% rename from docs/_concepts/DISTRO_PORTING.md rename to docs/DISTRO_PORTING.md diff --git a/docs/_interfaces/ELF_PACKAGE_METADATA.md b/docs/ELF_PACKAGE_METADATA.md similarity index 100% rename from docs/_interfaces/ELF_PACKAGE_METADATA.md rename to docs/ELF_PACKAGE_METADATA.md diff --git a/docs/_interfaces/ENVIRONMENT.md b/docs/ENVIRONMENT.md similarity index 100% rename from docs/_interfaces/ENVIRONMENT.md rename to docs/ENVIRONMENT.md diff --git a/docs/_userdocs/FAQ.md b/docs/FAQ.md similarity index 99% rename from docs/_userdocs/FAQ.md rename to docs/FAQ.md index 5239dbb0e5..483645b1e7 100644 --- a/docs/_userdocs/FAQ.md +++ b/docs/FAQ.md @@ -112,4 +112,3 @@ A: That's a long story, and that's why we have a wiki page of its own about this **Q: My systemd system always comes up with `/tmp` as a tiny `tmpfs`. How do I get rid of this?** A: That's also a long story, please have a look on [API File Systems](../API_FILE_SYSTEMS) - diff --git a/docs/_interfaces/FILE_DESCRIPTOR_STORE.md b/docs/FILE_DESCRIPTOR_STORE.md similarity index 100% rename from docs/_interfaces/FILE_DESCRIPTOR_STORE.md rename to docs/FILE_DESCRIPTOR_STORE.md diff --git a/docs/_groups/GROUP_RECORD.md b/docs/GROUP_RECORD.md similarity index 100% rename from docs/_groups/GROUP_RECORD.md rename to docs/GROUP_RECORD.md diff --git a/docs/_contributing/HACKING.md b/docs/HACKING.md similarity index 100% rename from docs/_contributing/HACKING.md rename to docs/HACKING.md diff --git a/docs/_groups/HOME_DIRECTORY.md b/docs/HOME_DIRECTORY.md similarity index 100% rename from docs/_groups/HOME_DIRECTORY.md rename to docs/HOME_DIRECTORY.md diff --git a/docs/_userdocs/INCOMPATIBILITIES.md b/docs/INCOMPATIBILITIES.md similarity index 100% rename from docs/_userdocs/INCOMPATIBILITIES.md rename to docs/INCOMPATIBILITIES.md diff --git a/docs/_devdocs/INHIBITOR_LOCKS.md b/docs/INHIBITOR_LOCKS.md similarity index 100% rename from docs/_devdocs/INHIBITOR_LOCKS.md rename to docs/INHIBITOR_LOCKS.md diff --git a/docs/_interfaces/INITRD_INTERFACE.md b/docs/INITRD_INTERFACE.md similarity index 100% rename from docs/_interfaces/INITRD_INTERFACE.md rename to docs/INITRD_INTERFACE.md diff --git a/docs/_interfaces/JOURNAL_EXPORT_FORMATS.md b/docs/JOURNAL_EXPORT_FORMATS.md similarity index 100% rename from docs/_interfaces/JOURNAL_EXPORT_FORMATS.md rename to docs/JOURNAL_EXPORT_FORMATS.md diff --git a/docs/_interfaces/JOURNAL_FILE_FORMAT.md b/docs/JOURNAL_FILE_FORMAT.md similarity index 100% rename from docs/_interfaces/JOURNAL_FILE_FORMAT.md rename to docs/JOURNAL_FILE_FORMAT.md diff --git a/docs/_interfaces/JOURNAL_NATIVE_PROTOCOL.md b/docs/JOURNAL_NATIVE_PROTOCOL.md similarity index 100% rename from docs/_interfaces/JOURNAL_NATIVE_PROTOCOL.md rename to docs/JOURNAL_NATIVE_PROTOCOL.md diff --git a/docs/_interfaces/MEMORY_PRESSURE.md b/docs/MEMORY_PRESSURE.md similarity index 100% rename from docs/_interfaces/MEMORY_PRESSURE.md rename to docs/MEMORY_PRESSURE.md diff --git a/docs/_devdocs/MINIMAL_BUILDS.md b/docs/MINIMAL_BUILDS.md similarity index 100% rename from docs/_devdocs/MINIMAL_BUILDS.md rename to docs/MINIMAL_BUILDS.md diff --git a/docs/_booting/MOUNT_REQUIREMENTS.md b/docs/MOUNT_REQUIREMENTS.md similarity index 100% rename from docs/_booting/MOUNT_REQUIREMENTS.md rename to docs/MOUNT_REQUIREMENTS.md diff --git a/docs/_userdocs/MY_SERVICE_CANT_GET_REATLIME.md b/docs/MY_SERVICE_CANT_GET_REATLIME.md similarity index 99% rename from docs/_userdocs/MY_SERVICE_CANT_GET_REATLIME.md rename to docs/MY_SERVICE_CANT_GET_REATLIME.md index eee389ad70..20d31fbde7 100644 --- a/docs/_userdocs/MY_SERVICE_CANT_GET_REATLIME.md +++ b/docs/MY_SERVICE_CANT_GET_REATLIME.md @@ -26,4 +26,3 @@ Of course, that's quite a limitation, so here's how you work around this: Note that this all only applies to services. By default, user applications run in the root cgroup of the "cpu" hierarchy, which avoids these problems for normal user applications. In the long run we hope that the kernel is fixed to not require an RT budget to be assigned for any cgroup created before a process can acquire RT (i.e. a process' RT budget should be derived from the nearest ancestor cgroup which has a budget assigned, rather than unconditionally its own uninitialized budget.) Ideally, we'd also like to create a per-user cgroup by default, so that users with many processes get roughly the same amount of CPU as users with very few. - diff --git a/docs/_networking/NETWORK_ONLINE.md b/docs/NETWORK_ONLINE.md similarity index 100% rename from docs/_networking/NETWORK_ONLINE.md rename to docs/NETWORK_ONLINE.md diff --git a/docs/_devdocs/OPTIMIZATIONS.md b/docs/OPTIMIZATIONS.md similarity index 100% rename from docs/_devdocs/OPTIMIZATIONS.md rename to docs/OPTIMIZATIONS.md diff --git a/docs/_interfaces/PASSWORD_AGENTS.md b/docs/PASSWORD_AGENTS.md similarity index 100% rename from docs/_interfaces/PASSWORD_AGENTS.md rename to docs/PASSWORD_AGENTS.md diff --git a/docs/_interfaces/PORTABILITY_AND_STABILITY.md b/docs/PORTABILITY_AND_STABILITY.md similarity index 100% rename from docs/_interfaces/PORTABILITY_AND_STABILITY.md rename to docs/PORTABILITY_AND_STABILITY.md diff --git a/docs/_concepts/PORTABLE_SERVICES.md b/docs/PORTABLE_SERVICES.md similarity index 100% rename from docs/_concepts/PORTABLE_SERVICES.md rename to docs/PORTABLE_SERVICES.md diff --git a/docs/_contributing/PORTING_TO_NEW_ARCHITECTURES.md b/docs/PORTING_TO_NEW_ARCHITECTURES.md similarity index 100% rename from docs/_contributing/PORTING_TO_NEW_ARCHITECTURES.md rename to docs/PORTING_TO_NEW_ARCHITECTURES.md diff --git a/docs/_networking/PREDICTABLE_INTERFACE_NAMES.md b/docs/PREDICTABLE_INTERFACE_NAMES.md similarity index 100% rename from docs/_networking/PREDICTABLE_INTERFACE_NAMES.md rename to docs/PREDICTABLE_INTERFACE_NAMES.md diff --git a/docs/_devdocs/PRESET.md b/docs/PRESET.md similarity index 100% rename from docs/_devdocs/PRESET.md rename to docs/PRESET.md diff --git a/docs/_concepts/RANDOM_SEEDS.md b/docs/RANDOM_SEEDS.md similarity index 100% rename from docs/_concepts/RANDOM_SEEDS.md rename to docs/RANDOM_SEEDS.md diff --git a/docs/_contributing/RELEASE.md b/docs/RELEASE.md similarity index 100% rename from docs/_contributing/RELEASE.md rename to docs/RELEASE.md diff --git a/docs/_networking/RESOLVED-VPNS.md b/docs/RESOLVED-VPNS.md similarity index 100% rename from docs/_networking/RESOLVED-VPNS.md rename to docs/RESOLVED-VPNS.md diff --git a/docs/_interfaces/ROOT_STORAGE_DAEMONS.md b/docs/ROOT_STORAGE_DAEMONS.md similarity index 100% rename from docs/_interfaces/ROOT_STORAGE_DAEMONS.md rename to docs/ROOT_STORAGE_DAEMONS.md diff --git a/docs/_contributing/SECURITY.md b/docs/SECURITY.md similarity index 100% rename from docs/_contributing/SECURITY.md rename to docs/SECURITY.md diff --git a/docs/_userdocs/SEPARATE_USR_IS_BROKEN.md b/docs/SEPARATE_USR_IS_BROKEN.md similarity index 99% rename from docs/_userdocs/SEPARATE_USR_IS_BROKEN.md rename to docs/SEPARATE_USR_IS_BROKEN.md index aa821f4a72..8e9390eff4 100644 --- a/docs/_userdocs/SEPARATE_USR_IS_BROKEN.md +++ b/docs/SEPARATE_USR_IS_BROKEN.md @@ -38,4 +38,3 @@ On the Fedora distribution we have succeeded to clean up the situation and the c In this new definition of /usr, the directory can be mounted read-only by default, while the rootfs may be either read-write or read-only (for stateless systems) and contains only the empty mount point directories, compat-symlinks to /usr and the host-specific data like /etc, /root, /srv. In comparison to today's setups, the rootfs will be very small. The host-specific data will be properly separated from the installed operating system. The new /usr could also easily be shared read-only across several systems. Such a setup would be more efficient, can provide additional security, is more flexible to use, provides saner options for custom setups, and is much simpler to setup and maintain. For more information on this please continue to [The Case for the /usr Merge](../THE_CASE_FOR_THE_USR_MERGE). - diff --git a/docs/_devdocs/SYSLOG.md b/docs/SYSLOG.md similarity index 100% rename from docs/_devdocs/SYSLOG.md rename to docs/SYSLOG.md diff --git a/docs/_devdocs/SYSTEMD_FILE_HIERARCHY_REQUIREMENTS.md b/docs/SYSTEMD_FILE_HIERARCHY_REQUIREMENTS.md similarity index 100% rename from docs/_devdocs/SYSTEMD_FILE_HIERARCHY_REQUIREMENTS.md rename to docs/SYSTEMD_FILE_HIERARCHY_REQUIREMENTS.md diff --git a/docs/_interfaces/TEMPORARY_DIRECTORIES.md b/docs/TEMPORARY_DIRECTORIES.md similarity index 100% rename from docs/_interfaces/TEMPORARY_DIRECTORIES.md rename to docs/TEMPORARY_DIRECTORIES.md diff --git a/docs/_contributing/TESTING_WITH_SANITIZERS.md b/docs/TESTING_WITH_SANITIZERS.md similarity index 100% rename from docs/_contributing/TESTING_WITH_SANITIZERS.md rename to docs/TESTING_WITH_SANITIZERS.md diff --git a/docs/_devdocs/THE_CASE_FOR_THE_USR_MERGE.md b/docs/THE_CASE_FOR_THE_USR_MERGE.md similarity index 100% rename from docs/_devdocs/THE_CASE_FOR_THE_USR_MERGE.md rename to docs/THE_CASE_FOR_THE_USR_MERGE.md diff --git a/docs/_userdocs/TIPS_AND_TRICKS.md b/docs/TIPS_AND_TRICKS.md similarity index 99% rename from docs/_userdocs/TIPS_AND_TRICKS.md rename to docs/TIPS_AND_TRICKS.md index d9a106a922..f181f122a8 100644 --- a/docs/_userdocs/TIPS_AND_TRICKS.md +++ b/docs/TIPS_AND_TRICKS.md @@ -183,4 +183,3 @@ $ systemd --test --system --unit=foobar.target ``` for a boot target foobar.target. Note that this is mostly a debugging tool that actually does a lot more than just calculate the initial transaction, so don't build scripts based on this. - diff --git a/docs/_booting/TPM2_PCR_MEASUREMENTS.md b/docs/TPM2_PCR_MEASUREMENTS.md similarity index 100% rename from docs/_booting/TPM2_PCR_MEASUREMENTS.md rename to docs/TPM2_PCR_MEASUREMENTS.md diff --git a/docs/_interfaces/TRANSIENT-SETTINGS.md b/docs/TRANSIENT-SETTINGS.md similarity index 100% rename from docs/_interfaces/TRANSIENT-SETTINGS.md rename to docs/TRANSIENT-SETTINGS.md diff --git a/docs/_contributing/TRANSLATORS.md b/docs/TRANSLATORS.md similarity index 100% rename from docs/_contributing/TRANSLATORS.md rename to docs/TRANSLATORS.md diff --git a/docs/_groups/UIDS-GIDS.md b/docs/UIDS-GIDS.md similarity index 100% rename from docs/_groups/UIDS-GIDS.md rename to docs/UIDS-GIDS.md diff --git a/docs/_groups/USERDB_AND_DESKTOPS.md b/docs/USERDB_AND_DESKTOPS.md similarity index 100% rename from docs/_groups/USERDB_AND_DESKTOPS.md rename to docs/USERDB_AND_DESKTOPS.md diff --git a/docs/_groups/USER_GROUP_API.md b/docs/USER_GROUP_API.md similarity index 100% rename from docs/_groups/USER_GROUP_API.md rename to docs/USER_GROUP_API.md diff --git a/docs/_groups/USER_NAMES.md b/docs/USER_NAMES.md similarity index 100% rename from docs/_groups/USER_NAMES.md rename to docs/USER_NAMES.md diff --git a/docs/_groups/USER_RECORD.md b/docs/USER_RECORD.md similarity index 99% rename from docs/_groups/USER_RECORD.md rename to docs/USER_RECORD.md index b88a67e66b..a92711f275 100644 --- a/docs/_groups/USER_RECORD.md +++ b/docs/USER_RECORD.md @@ -76,7 +76,7 @@ Similar to JSON User Records there are also JSON User Records are not suitable for storing all identity information about the user, such as binary data or large unstructured blobs of text. These parts -of a user's identity should be stored in the [Blob Directories](USER_RECORD_BLOB_DIRS.md). +of a user's identity should be stored in the [Blob Directories](USER_RECORD_BLOB_DIRS). JSON User Records may be transferred or written to disk in various protocols and formats. To inquire about such records defined on the local system use the @@ -235,10 +235,10 @@ user record with a realm set is never compatible (for the purpose of updates, see above) with a user record without one set, even if the `userName` field matches. `blobDirectory` → The absolute path to a world-readable copy of the user's blob -directory. See [Blob Directories](USER_RECORD_BLOB_DIRS.md) for more details. +directory. See [Blob Directories](USER_RECORD_BLOB_DIRS) for more details. `blobManifest` → An object, which maps valid blob directory filenames (see -[Blob Directories](USER_RECORD_BLOB_DIRS.md) for requirements) to SHA256 hashes +[Blob Directories](USER_RECORD_BLOB_DIRS) for requirements) to SHA256 hashes formatted as hex strings. This exists for the purpose of including the contents of the blob directory in the record's signature. Managers that support blob directories and utilize signed user records (like `systemd-homed`) should use diff --git a/docs/USER_RECORD_BLOB_DIRS.md b/docs/USER_RECORD_BLOB_DIRS.md index 8f5dd7914b..fd030e7966 100644 --- a/docs/USER_RECORD_BLOB_DIRS.md +++ b/docs/USER_RECORD_BLOB_DIRS.md @@ -8,7 +8,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later # User Record Blob Directories The blob directories are for storing binary or unstructured data that would -otherwise be stored in [JSON User Records](USER_RECORD.md). For instance, +otherwise be stored in [JSON User Records](USER_RECORD). For instance, this includes image files such as the user's avatar picture. This data, like most of the user record, will be made publicly available to the system. diff --git a/docs/_devdocs/VIRTUALIZED_TESTING.md b/docs/VIRTUALIZED_TESTING.md similarity index 100% rename from docs/_devdocs/VIRTUALIZED_TESTING.md rename to docs/VIRTUALIZED_TESTING.md diff --git a/docs/_devdocs/WRITING_DESKTOP_ENVIRONMENTS.md b/docs/WRITING_DESKTOP_ENVIRONMENTS.md similarity index 100% rename from docs/_devdocs/WRITING_DESKTOP_ENVIRONMENTS.md rename to docs/WRITING_DESKTOP_ENVIRONMENTS.md diff --git a/docs/_devdocs/WRITING_DISPLAY_MANAGERS.md b/docs/WRITING_DISPLAY_MANAGERS.md similarity index 100% rename from docs/_devdocs/WRITING_DISPLAY_MANAGERS.md rename to docs/WRITING_DISPLAY_MANAGERS.md diff --git a/docs/_devdocs/WRITING_NETWORK_CONFIGURATION_MANAGERS.md b/docs/WRITING_NETWORK_CONFIGURATION_MANAGERS.md similarity index 100% rename from docs/_devdocs/WRITING_NETWORK_CONFIGURATION_MANAGERS.md rename to docs/WRITING_NETWORK_CONFIGURATION_MANAGERS.md diff --git a/docs/_devdocs/WRITING_RESOLVER_CLIENTS.md b/docs/WRITING_RESOLVER_CLIENTS.md similarity index 100% rename from docs/_devdocs/WRITING_RESOLVER_CLIENTS.md rename to docs/WRITING_RESOLVER_CLIENTS.md diff --git a/docs/_devdocs/WRITING_VM_AND_CONTAINER_MANAGERS.md b/docs/WRITING_VM_AND_CONTAINER_MANAGERS.md similarity index 100% rename from docs/_devdocs/WRITING_VM_AND_CONTAINER_MANAGERS.md rename to docs/WRITING_VM_AND_CONTAINER_MANAGERS.md diff --git a/docs/_config.yml b/docs/_config.yml index 3d44889f80..412db1f413 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -4,32 +4,7 @@ title: systemd baseurl: "" # the subpath of your site, e.g. /blog/ url: "https://systemd.io" # the base hostname & protocol for your site +permalink: /:title/ + # Build settings markdown: kramdown - -collections: - concepts: - title: 'Concepts' - output: true - contributing: - title: 'Contributing' - output: true - userdocs: - output: true - title: 'Documentation for Users and Administrators' - booting: - title: 'Booting' - output: true - interfaces: - title: 'Interfaces' - output: true - networking: - title: 'Networking' - output: true - groups: - title: 'Users, Groups and Home Directories' - output: true - devdocs: - title: 'Documentation for Developers' - output: true - diff --git a/docs/_data/extra_pages.json b/docs/_data/extra_pages.json index 908e3a83dc..a393bb067a 100644 --- a/docs/_data/extra_pages.json +++ b/docs/_data/extra_pages.json @@ -1,4 +1,44 @@ [ + { + "category": "Project", + "title": "mkosi Project - Build Bespoke OS Images", + "url": "https://mkosi.systemd.io/" + }, + { + "category": "Project", + "title": "Brand", + "url": "https://brand.systemd.io/" + }, + { + "category": "Project", + "title": "Mailing List", + "url": "https://lists.freedesktop.org/mailman/listinfo/systemd-devel" + }, + { + "category": "Project", + "title": "Mastodon", + "url": "https://mastodon.social/@pid_eins" + }, + { + "category": "Project", + "title": "Releases", + "url": "https://github.com/systemd/systemd/releases" + }, + { + "category": "Project", + "title": "GitHub Project Page", + "url": "https://github.com/systemd/systemd" + }, + { + "category": "Project", + "title": "Issues", + "url": "https://github.com/systemd/systemd/issues" + }, + { + "category": "Project", + "title": "Pull Requests", + "url": "https://github.com/systemd/systemd/pulls" + }, { "category": "Manual Pages", "title": "Index", diff --git a/docs/_data/project.json b/docs/_data/project.json deleted file mode 100644 index 606c784483..0000000000 --- a/docs/_data/project.json +++ /dev/null @@ -1,42 +0,0 @@ -[ - { - "category": "Project", - "title": "mkosi Project - Build Bespoke OS Images", - "url": "https://mkosi.systemd.io/" - }, - { - "collection": "project", - "title": "Brand", - "url": "https://brand.systemd.io/" - }, - { - "collection": "project", - "title": "Mailing List", - "url": "https://lists.freedesktop.org/mailman/listinfo/systemd-devel" - }, - { - "collection": "project", - "title": "Mastodon", - "url": "https://mastodon.social/@pid_eins" - }, - { - "collection": "project", - "title": "Releases", - "url": "https://github.com/systemd/systemd/releases" - }, - { - "collection": "project", - "title": "GitHub Project Page", - "url": "https://github.com/systemd/systemd" - }, - { - "collection": "project", - "title": "Issues", - "url": "https://github.com/systemd/systemd/issues" - }, - { - "collection": "project", - "title": "Pull Requests", - "url": "https://github.com/systemd/systemd/pulls" - } -] diff --git a/docs/index.md b/docs/index.md index cd3916ca32..3c05c93550 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,27 +12,17 @@ systemd provides aggressive parallelization capabilities, uses socket and D-Bus Other parts include a logging daemon, utilities to control basic system configuration like the hostname, date, locale, maintain a list of logged-in users and running containers and virtual machines, system accounts, runtime directories and settings, and daemons to manage simple network configuration, network time synchronization, log forwarding, and name resolution. --- -## Project -{% for page in site.data.project %} -* [{{ page.title }}]({{ page.url | relative_url }}){% endfor %} - - -{% for c in site.collections %} - -{% if c.label != "posts" %} -## {{ c.title }} -{% for item in site[c.label] %} -* [{{ item.title }}]({{ item.url | relative_url }}){% endfor %} -{% endif %} -{% endfor %} - - -{% assign external_pages = site.data.extra_pages | group_by:"category" %} - -{% for category in external_pages %} -## {{ category.name }} -{% assign sorted = category.items | sort:"title" %}{% for page in sorted %} + +{% assign by_category = site.pages | group_by:"category" %} +{% assign extra_pages = site.data.extra_pages | group_by:"category" %} +{% assign merged = by_category | concat: extra_pages | sort:"name" %} + +{% for pair in merged %} + {% if pair.name != "" %} +## {{ pair.name }} +{% assign sorted = pair.items | sort:"title" %}{% for page in sorted %} * [{{ page.title }}]({{ page.url | relative_url }}){% endfor %} + {% endif %} {% endfor %} ## See also diff --git a/meson.build b/meson.build index d49f046014..5f5fa2eaf8 100644 --- a/meson.build +++ b/meson.build @@ -2527,13 +2527,13 @@ install_data('LICENSE.GPL2', 'LICENSE.LGPL2.1', 'NEWS', 'README', - 'docs/_contributing/CODING_STYLE.md', - 'docs/_concepts/DISTRO_PORTING.md', - 'docs/_interfaces/ENVIRONMENT.md', - 'docs/_contributing/HACKING.md', - 'docs/_interfaces/TRANSIENT-SETTINGS.md', - 'docs/_contributing/TRANSLATORS.md', - 'docs/_groups/UIDS-GIDS.md', + 'docs/CODING_STYLE.md', + 'docs/DISTRO_PORTING.md', + 'docs/ENVIRONMENT.md', + 'docs/HACKING.md', + 'docs/TRANSIENT-SETTINGS.md', + 'docs/TRANSLATORS.md', + 'docs/UIDS-GIDS.md', install_dir : docdir) install_subdir('LICENSES', diff --git a/test/units/testsuite-46.sh b/test/units/testsuite-46.sh index 52f92c5f57..d097ccdac8 100755 --- a/test/units/testsuite-46.sh +++ b/test/units/testsuite-46.sh @@ -305,7 +305,7 @@ homectl remove blob-user export PAGER= # Create a couple of user/group records to test io.systemd.DropIn -# See docs/_groups/USER_RECORD.md and docs/_groups/GROUP_RECORD.md +# See docs/USER_RECORD.md and docs/GROUP_RECORD.md mkdir -p /run/userdb/ cat >"/run/userdb/dropingroup.group" <<\EOF {