Commit graph

1095 commits

Author SHA1 Message Date
Lennart Poettering 7811864b08 CODING_STYLE: document "reterr_" return parameters
In some recent PRs (e.g. #32628) I started to systematically name return
parameters that shall only be initialized on failure (because they carry
additional error meta information, such as the line/column number of
parse failures or so). Let's make this official in the coding style.
2024-06-13 09:51:35 +02:00
Lennart Poettering 728c35d903
Merge pull request #33045 from poettering/exit-on-idle-tweaks
bus-util: honour new env var $SYSTEMD_ALLOW_IDLE to permit turning off exit-on-idle logic in hostnamed, timedated, …
2024-06-12 17:35:56 +02:00
Luca Boccassi 62cc0aca17 docs: update RELEASE.md to use same repository for stable branches 2024-06-12 14:30:29 +01:00
Lennart Poettering afc55a5eff bus-util: add env var for disabling exit-on-idle 2024-06-12 12:53:53 +02:00
Heran Yang 4762cf0b55 docs: fix escaped $ in CGroup Interface 2024-06-03 16:30:06 +01:00
Heran Yang 7f2ff8b312 docs: fix typo in CGroup Interface 2024-06-03 18:13:57 +09:00
Arian van Putten 30a15ce1d0 docs/DAEMON_SOCKET_ACTIVATION
Remove non-sensical network.target dependencies

There is no need to have these dependencies on socket units as far as I am aware.
2024-06-03 15:22:54 +09:00
Daan De Meyer ba592dc715 mkosi: Replace submodules with our own thing
Unfortunately, git submodules break in all sorts of ways:

- Various github workflows (dependabot, github pages) try to do a shallow
clone of git submodules which does not work at all when the git repository
is hosted on pagure (https://pagure.io/pagure/issue/5453,
https://github.com/dependabot/dependabot-core/issues/9391).
- If the git forge hosting the git repository uses SHA256, then it breaks our
usage of it as a submodule as SHA256 repositories cannot be used as submodules
in SHA1 repositories (src.opensuse.org moved to SHA256 which broke our usage of
opensuse's systemd spec as a submodule).
- git submodules completely break usage of git worktrees.
- ...

Let's avoid all these issues by just doing our own home grown implementation of
git submodules. We lose the automatic dependabot updates this way but since dependabot
fails to run more often that not with submodules we don't really lose anything.
2024-05-30 19:31:32 +02:00
Luca Boccassi 78247be91d
Merge pull request #33063 from keszybz/wiki-links
Update wiki links
2024-05-28 16:21:45 +02:00
Zbigniew Jędrzejewski-Szmek bdc965253c docs: drop link to obsolete multiseat page
We link to the man page which replaced this historical document right above,
so just drop the whole paragraph.
2024-05-28 14:48:56 +02:00
Zbigniew Jędrzejewski-Szmek b346d72c79 man: update links to "Compatibility with SysV" 2024-05-28 14:46:44 +02:00
Mathias Lang 60d285a2b4 docs/CONTRIBUTING.md: Fix links in CONTRIBUTING
Get them to point to the rendered version, instead of
letting Github thinks they are absolute links in the
repository. The rendered version is much more user-friendly.
2024-05-28 12:53:18 +02:00
Luca Boccassi 742ee96dbe
Merge pull request #32784 from YHNdnzj/release-version
docs/RELEASE: use meson.version for tags
2024-05-15 20:25:59 +02:00
Luca Boccassi 93df5217b9 tree-wide: 'allows to' -> 'allows one to'
As flagged by Lintian
2024-05-14 18:33:27 +02:00
Mike Yuan 10fae6ac6e
docs/RELEASE: meson.version doesn't contain "v" prefix 2024-05-13 21:58:29 +08:00
Mike Yuan efbe45e4ed
docs/RELEASE: use meson.version for tags 2024-05-13 21:58:29 +08:00
Colin Watson 566491c971 docs,man: Avoid some ambiguous uses of "may not"
Like much English text, the systemd documentation uses "may not" in the
sense of both "will possibly not" and "is forbidden to".  In many cases
this is OK because the context makes it clear, but in others I felt it
was possible to read the "is forbidden to" sense by mistake: in
particular, I tripped over "the target file may not exist" in
systemd.unit(5) before realizing the correct interpretation.

Use "might not" or "may choose not to" in these cases to make it clear
which sense we mean.
2024-05-08 17:14:32 +02:00
Luca Boccassi cb7e3126b9 docs: add specification for ELF dlopen metadata
Tool to parse it and to use it for Debian packaging available at
https://github.com/systemd/package-notes

Add 3 levels of priority like Debian does, but using terminology
from RPM as it seems more apt.
We will very likely never use 'required', as we use this functionality
for optional features, but it is worth having it in the spec nonetheless
as we want it to be generalized.
2024-05-08 11:07:36 +01:00
Adrian Wannenmacher 3a1694803b docs: minor improvements to CREDENTIALS.md
This commit fixes two instances of a miscount. As the number is not important in either case, and seemingly subject to changes, it was removed entirely.

Another sentence was reworded to improve readability.
2024-05-07 11:02:31 +02:00
Daan De Meyer f779fd1f8f meson: Set up git submodule update on post checkout as well 2024-05-05 14:49:21 +02:00
Lennart Poettering d4ffb37bb1 nspawn, vmspawn, run0: add env var for turning off background tinting
Some people are just sad, sad lost souls who don't like even the tiniest
ray of color in their life. Let's add an env var knob for allowing them
to turn the background tinting off, to drive the last bit of color from
their life so that they can stay in their grey grey life.
2024-05-02 23:33:39 +02:00
Luca Boccassi c8de1a8c56 docs: move information from AUTOPKGTEST.md to test/README.testsuite and delete it
This is not information that needs to be published on systemd.io as it's
purely internal, so the README is enough
2024-05-01 01:30:12 +01:00
Luca Boccassi a8fa9f32e6 docs: drop outdated documents about os-release and cgroupsv1
cgroupv1 is deprecated, and os-release has a fully fledged manpage
2024-05-01 01:30:12 +01:00
Skia ad23fca3ae docs: autopkgtest: refresh the docs with up-to-date information
@iainlane doesn't work on Ubuntu infrastructure anymore, and `bionic` is still ESM, but not really supported anymore either.  
`noble`, which is the latest Ubuntu, probably is better for testing `systemd` in 2024, and pinging `qa-help` on IRC is the current official way to contact the team behind Ubuntu's infrastructure.
2024-04-30 16:16:31 +02:00
nl6720 92ecff6098 docs/DEBUGGING.md: use an underscore in the kernel command line option
systemd-debug-generator(8) lists it as `systemd.debug_shell`.

According to 1d84ad9445, kernel command
line options should use an underscore instead of a dash.
2024-04-29 14:16:57 +02:00
spdfnet 7fee8faa60 docs: update link for SUSE whitepaper
Signed-off-by: spdfnet <32593931+spdfnet@users.noreply.github.com>
2024-04-28 12:44:21 +02:00
Dmitry V. Levin c309b9e9c3 treewide: fix a few typos in NEWS, docs, comments, and log messages 2024-04-27 12:11:13 +02:00
Frantisek Sumsal 7248912d10 docs: PrepareForSuspend() is not a valid signal name 2024-04-26 14:57:22 +02:00
Frantisek Sumsal 3f1c304803 docs: drop invalid links 2024-04-26 14:57:22 +02:00
Lennart Poettering 6f9a1adf6d vmspawn: add env var that can extend the qemu cmdline
This is a bit hackish, but really useful sometimes to play around with
some qemu switches.
2024-04-20 12:10:42 +02:00
Luca Boccassi 4d3d187493
Merge pull request #32324 from mrc0mmand/more-website-fixes
docs: use absolute links for our pages
2024-04-18 10:55:01 +02:00
Lennart Poettering 778abdbfa1 doc: fix .ssh credential examples
Let's create the .ssh dir with the right perms first.

Suggested by @gcb.

Fixes: #28172
2024-04-18 10:53:20 +02:00
Daan De Meyer 9fede461ca docs: Add note on packages produced by mkosi builds 2024-04-18 09:58:50 +02:00
Yu Watanabe d2a0ef6073
Merge pull request #32249 from CodethinkLabs/vmspawn/predicatable_tap_names
vmspawn: generate predicatable TAP device names and MAC addresses
2024-04-18 10:26:07 +09:00
Frantisek Sumsal 0d592a5e17 docs: use absolute links for our pages
Since 56b2970 has proven to be a no-go for us, as it breaks existing
links, let's embrace the trailing slash and use absolute links
everywhere for our pages. This way we'll get around browser cleverly
appending the relative link to the current location (since it ends with
a slash), and given our docs/ layout is flat it's not much of a hassle
either.

Converted using this beauty:
  $ sed -ri 's/(\[.+\]\()([A-Z_]+\))/\1\/\2/g' *.md

Resolves: #32088 (again) and #32310
2024-04-17 21:21:23 +02:00
Frantisek Sumsal 87c22d4377 Revert "docs: don't suffix page permalink with a slash"
This breaks existing links with a trailing slash, so it's a no-go.

This reverts commit d1a7e030c5.
2024-04-17 20:53:49 +02:00
Zbigniew Jędrzejewski-Szmek 9f74901a1e Merge pull request #31648 from neighbourhoodie/review-content
I did the merge manually to resolve a trivial conflict.
2024-04-17 17:41:07 +02:00
Daan De Meyer 9d98617c1a Update debugging with vscode section
- We have ssh-generator now, so need for mkosi's Ssh= option anymore.
- By enabling RuntimeBuildSources= by default, we don't need the gdb
  config file in the image anymore, since the build and source
  directories will be mounted at the expected locations.
2024-04-16 15:25:34 +02:00
Sam Leonard c3dd4e20fe
vmspawn: generate predicatable TAP device names and MAC addresses 2024-04-15 11:42:06 +01:00
Frantisek Sumsal d1a7e030c5 docs: don't suffix page permalink with a slash
As it breaks relative links to other pages. For example, the
BOOT_LOADER_INTERFACE page has a relative link to
AUTOMATIC_BOOT_ASSESSMENT. With a slash in the page's permalink, that
link leads to:

http://127.0.0.1:4000/BOOT_LOADER_INTERFACE/AUTOMATIC_BOOT_ASSESSMENT

which is incorrect. Dropping the trailing slash makes the link link to
the correct place:

http://127.0.0.1:4000/AUTOMATIC_BOOT_ASSESSMENT

Resolves: #32088
2024-04-15 10:54:33 +02:00
Yu Watanabe 1ae891037e
Merge pull request #32202 from DaanDeMeyer/assert
tests: Improve assertion error messages
2024-04-11 09:51:49 +09:00
Daan De Meyer 5c041971eb docs: Add Tests section to coding style doc 2024-04-10 18:24:29 +02:00
Daan De Meyer f1e9e8041c git: Add post-rewrite hook that invokes git submodule update
git rebase does not support a --recurse-submodules switch to automatically
check out the submodules at their registered commits during or after a rebase.

Instead, let's use the post-rewrite git hook to do this ourselves.
2024-04-10 14:39:49 +02:00
Daan De Meyer 957dc5f190 docs: Suggest soft-reboot to restart pid1 and all daemons in mkosi VM 2024-04-08 22:21:51 +01:00
Daan De Meyer e71b40fd00 docs: Add note on RuntimeBuildSources= to hacking guide 2024-04-08 11:37:34 +01:00
Lennart Poettering 702a52f4b5 mountfsd: add new systemd-mountfsd component 2024-04-06 16:08:24 +02:00
Luca Boccassi 485bb19d55 docs: notify example was moved to sd_notify manpage
Reference in the portability doc was forgot

Follow-up for 383917ac67
2024-04-02 22:24:38 +01:00
Luca Boccassi 383917ac67 man: add self-contained example of notify protocol
We are saying in public that the protocl is stable and can be easily
reimplemented, so provide an example doing so in the documentation,
license as MIT-0 so that it can be copied and pasted at will.
2024-04-02 14:53:31 +01:00
hulkoba 6d0612f6e6
docs/RANDOM_SEEDS: update NetBSD link 2024-03-27 07:31:56 +01:00
hulkoba 997a84b2e1
chore(docs): change permalink at the Jekyll config
Some of the internal links didn't work.
To make them work we had two options:

1. Keep the trailing slash at the jecyll config:
The built structure of the html files is one directory for each file, including a html file.
This is why a relative link including the `../` is required to get out of the built folder and make it work.
e.g.
config: permalink: /:title/
HACKING.md: [Coding Style](../CODING_STYLE)

2. Remove the trailing slash, the built structure is like the structure in dev: one html file for each markdown file.
In this case, the links as they are implemented just work.
e.g.
config: permalink: /:title
HACKING.md: [Coding Style](CODING_STYLE)

We use option 2 :)
2024-03-27 07:31:55 +01:00