1
0
mirror of https://github.com/systemd/systemd.git synced 2025-01-11 09:18:07 +03:00
Commit Graph

8768 Commits

Author SHA1 Message Date
Marcel Hellwig
072ea04e26 Update sd_bus_message_append_array.xml
fix pointer constness in documentation

(cherry picked from commit fec09ff094)
2024-10-08 16:39:12 +01:00
Daniel Dawson
7323feef9b systemd-integritysetup: accept integrity-algorithm=xxhash64
Signed-off-by: Daniel Dawson <danielcdawson@gmail.com>
(cherry picked from commit 0c96911afb)
2024-10-08 16:39:12 +01:00
Lennart Poettering
4bdbfb3dd4 man: add a comment that inode type policy might be enforces via an LSM or similar
Just to tighten the language a bit, why people should care about where
they place their inodes.

(cherry picked from commit 5b53894123)
2024-10-08 16:39:12 +01:00
Lennart Poettering
c14890f588 man: clarify that the defined file hiearchy is just a skeleton
(And specifically mention /usr/include + /var/spool as not covered here,
but being OK to add downstream)

(cherry picked from commit fd6e079e7b)
2024-10-08 16:39:12 +01:00
Lennart Poettering
82783a3c5f man: drop /var/spool/ mention from file-hierarchy(7) man page
Today it seems this is mostly used by mail and printer servers, and it's
not clear to me at all what the property is that makes
/var/spool/<package> the better place for the relevant data than
/var/lib/<package>.

Hence, in the interest of shortening the spec, let's not mention the dir
anymore. In particular as the dir really isn't used by us much, for
example we do not have a counterpart for RuntimeDirectory=,
StateDirectory=, … that would cover the spool.

Since most systems these days we care about probably come *without* a
printer or mail server, let's maybe no mention this in the man page that
is supposed to discuss the rough skeleton how things are set up. After
all, people are supposed to exend the skeleton with their stuff, and
this sounds more like a case for an extension of the skeleton instead of
being considered part of the skeleton itself.

(cherry picked from commit b0201b36d2)
2024-10-08 16:39:12 +01:00
Lennart Poettering
e5ac408af7 man: drop mention of /usr/include/ from file-hierarchy(7) man page
The man page is supposed to provide a "generalized, though minimal and
modernized subset" (as per introductory pargapraghs), from a systemd
perspective. But the thing is that /usr/include/ really doesn't matter
to us. It's a development thing, and slightly weird (because it arguably
would be better places in /usr/share/include/ or so). It's not going to
be there on 95% of deployed systems, and we really don't want people to
bother with it on such systems.

We only define the skeleton of directories in this document, and it's
expected that people extend it, and I think this really should be one of
those dirs that is an extension of our skeleton, but not part of the
skeleton, if that makes any sense.

(cherry picked from commit 9e7b691073)
2024-10-08 16:39:12 +01:00
Zbigniew Jędrzejewski-Szmek
53b5032ffd man: fix formatting in file-hierarchy
Somebody wrapped the text, but whitespace is preserved in <programlisting>, so
the output was mangled. It also doesn't make sense to run systemd-path as root
(as indicated by '#'), so drop that. Also, this chunk should be a separate
paragraph.

(cherry picked from commit 1ca81b2e00)
2024-10-08 16:39:12 +01:00
Zbigniew Jędrzejewski-Szmek
2cd8079efa man: say that SYSEXT_SCOPE=initrd also applies to exitrds
We generally do _not_ want the same sysexts to be loaded in both initrd and
exitrd phases. The environment is completely different and it's unlikely that
the same code can be useful in both places. Nevertheless, it can be useful in
_some_ cases, for example when the sysexts contains debugging tools.

I think we don't need to differentiate between initrds and exitrds through
SYSEXT_SCOPE, because the two types are made available in completely different
locations and loaded through a different mechanism, with very little chance of
an initrd being loaded as an exitrd without an explicit admin action (or the
other way around). So let's not complicate our code or definitions by an
explicit "exitrd" sysext designator, but just clarify that "initrd" also
encompasses exitrds in this context.

(cherry picked from commit 7352a0093f)
2024-10-08 16:39:12 +01:00
Zbigniew Jędrzejewski-Szmek
b78f99e71b man: slightly enhance docs about "exitrd" and remove TODO entry for it
The concept is fairly well established and present in our docs in various
places.

Say that the exitrd is also marked by the presence of /etc/initrd-release.

(cherry picked from commit ace26a511f)
2024-10-08 16:39:12 +01:00
cvlc12
f535bbea13 man: update PCR and Secure Boot key names and paths
(cherry picked from commit dbf5b09de4)
2024-10-08 16:39:12 +01:00
Yu Watanabe
84d5d3af9d man: fix typo
Follow-up for 8aee931e7a.

(cherry picked from commit 07e6a111c0)
2024-10-08 16:39:12 +01:00
Yu Watanabe
9ab5eba325 network: make IPMasquerade= imply global IP forwarding settings again
After 3976c43092 (#31423), IPMasquerade=
implies only per-interface IP forwarding. That means, nspawn users need
to manually enable IPv4/IPv6Forwarding= in networkd.conf when
--network-veth or friend is used. Even the change was announced in NEWS,
the change itself breaks backward compatibility and extremely reduces
usability.

Let's make the setting imply the global setting again.

Fixes #34010.

(cherry picked from commit 0b695febb2)
2024-09-10 14:56:05 +02:00
Thorsten Scherer
2665618555 repart: Fix misleading typo in GPT partition flag
Bit 60 is the one corresponding to ReadOnly, not 50.  Fix this.

(cherry picked from commit 932cc94436)
2024-08-15 14:04:41 +01:00
James Muir
817dcbe7a6 man/systemd-sysusers, man/systemd-tmpfiles: fix sentence fragments
add "are executed" so that those two sentences have a verb.

(cherry picked from commit c5903cde63)
2024-08-15 14:04:41 +01:00
Yu Watanabe
ce940b62ac man/net-naming-scheme: mention that NAMING_BRIDGE_MULTIFUNCTION_SLOT is reverted
Follow-up for af7417ac7b.
Closes #33596.

(cherry picked from commit 1c0130e8dc)
2024-08-15 14:04:41 +01:00
Yu Watanabe
ab4e1faca6 man: extend explanation for ConfigureWithoutCarrier= in systemd.network(5)
Prompted by #33702.

(cherry picked from commit 347c8822d1)
2024-08-15 14:04:41 +01:00
Daniel P. Berrangé
037510812f man/systemd-detect-virt: list known CVM technologies
Add a section which lists the known confidential virtual machine
technologies.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
(cherry picked from commit a8fb5d21fd)
2024-08-15 14:04:41 +01:00
Yu Watanabe
cab78ad49f man: suggest to enable global IPv6Forwarding= setting to make IPv6 packets forwarded
Closes #33414.

(cherry picked from commit 175cdefd33)
2024-08-15 14:04:41 +01:00
Yu Watanabe
166b704a41 network: mention that IPv4 ACD is enabled by default for 169.254.0.0/16
Prompted by #33824.

(cherry picked from commit dd87ad8e19)
2024-08-15 14:04:40 +01:00
Arian van Putten
f23fe35c9f document how TimeoutStartSec= affects notify-reload (#33653)
* document how TimeoutStartSec=  affects notify-reload

(cherry picked from commit a55d1b29a4)
2024-08-15 13:08:37 +01:00
Nick Cao
fb44ee8908 man: network: move note about L3MasterDevice to the correct section
(cherry picked from commit 034b7dfc08)
2024-08-15 13:08:37 +01:00
Vladimir Panteleev
ec3f2c8c8a man: clarify systemd-path variable source
(cherry picked from commit 3f24fa57df)
2024-08-15 13:08:37 +01:00
Vladimir Panteleev
5cf0c45f64 man: improve ManagerEnvironment documentation
- Improve wording for explanation when these variables are inherited

- Clarify that these variables are not placed in the process environment block,
  so /proc/PID/environ cannot be used as a debugging tool

(cherry picked from commit 6c1e0823b0)
2024-08-15 13:08:37 +01:00
Daniel P. Berrangé
b077417713 man/systemd-detect-virt: fix row spanning for VM header
This fixes

  commit 9b0688f491
  Author: Yu Watanabe <watanabe.yu+github@gmail.com>
  Date:   Tue Jan 9 10:52:49 2024 +0900

    virt: add Google Compute Engine support

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
(cherry picked from commit 9ffdfc67c6)
2024-08-05 16:02:36 +02:00
Zbigniew Jędrzejewski-Szmek
e60d01bdbf man/systemd-repart: extend description and reword some sentences
The page was written when systemd-repart was primarily intended to be used on a
running system. But nowadays it's more often used to create images, so extend
that part of the description.

While at it, fix some whitespace issues and trim some overly complicated sentences.

(cherry picked from commit d202ea5754)
2024-07-24 14:26:49 +02:00
Steve Traylen
766af3f782 Document that MemorySwapMax supports % configuration
Certainly on systemd 252 at least a configuration of
```
MemorySwapMax=40%
```
is supported but this was missing from the man page.
Only MemoryMax was documented as supporting a %.

(cherry picked from commit 8af38e5b04)
2024-07-24 14:26:49 +02:00
Lucas Werkmeister
468b064634 man: Mention Type=oneshot timeout directive
Make the warning for oneshot services (where RuntimeMaxSec= has no
effect) more actionable by pointing to the directive people can use
instead to effectively limit their runtime.

(cherry picked from commit 8c4aa0f1c6)
2024-07-22 11:05:08 +01:00
Lennart Poettering
78fcf31f08 man: some fixes
Addons are called addons, say so. And some other fixes.

(cherry picked from commit 40d9c16d1e)
2024-07-22 10:26:01 +01:00
Kuntal Majumder
bcda6d4637 man: fix typo in unit options section
Fixes #32918

(cherry picked from commit f9572d2b89)
2024-07-22 10:26:01 +01:00
ZHANG Yuntian
a68188e985 man: fix typo in the alias symlink name
Symlink created by Alias will use the value as the file name.

(cherry picked from commit 3f0e7fd4fd)
2024-07-22 10:26:01 +01:00
Mike Yuan
bb71d5dfb4 man/systemctl: --no-reload is honored by mask/unmask/preset too
(cherry picked from commit 399646faac)
2024-07-20 00:33:14 +02:00
Lennart Poettering
df1ed3fbe2 man: fully adopt ~/.local/state/
The XDG base dir spec adopted ~/.local/state/ as a thing a while back,
and we updated our docs in b4d6bc63e6, but
forgot to to update the table at the bottom to fully reflect the update.
Fix that.

(cherry picked from commit 72a6296b16)
2024-07-05 20:00:04 +02:00
Lennart Poettering
9d40e5c9c6 man: mention that distinction between /usr/lib/ and /usr/share/ is really about shared *ownership*
(cherry picked from commit 39aafbd42a)
2024-07-05 20:00:04 +02:00
Lennart Poettering
8dbb7e2a72 man: drop version info from file hiearchy man page
This file doesn't document features of systemd, but is more a of a
general description that generalizes/modernizes FHS. As such, the items
listed in it weren't "added" in systemd versions, they simply reflect
general concepts independent of any specific systemd version. hence
let's drop this misleading and confusing version info.

Or in other words, the man page currently claims under "/usr/": "Added
in version 215." – Which of course is rubbish, the directory existed
since time began.

This also rebreaks all paragaphs this touches.

No content changes.

(cherry picked from commit 26db8fe247)
2024-07-05 20:00:04 +02:00
Giovanni Baratta
2f455914f7 man/tmpfiles: remove outdated behavior regarding symlink ownership
Update the man page of tmpfiles.d to remove outdated comments regarding the behavior of ownership with symlinks.
The behavior has been changed in this commit 51207ca134

(cherry picked from commit d108198f39)
2024-07-05 20:00:04 +02:00
Mike Yuan
e2fb3dda24 man/capsule@.service: the capsule user is prefixed with "c-" rather than "p_"
(cherry picked from commit 6343d2ea50)
2024-07-05 20:00:04 +02:00
Carlo Teubner
2547de4629 man/capsule@.service.xml: fix typo
(cherry picked from commit 6733d691bb)
2024-07-05 20:00:04 +02:00
Diego Viola
421ccd7094 man: fix double is typo in systemd-tmpfiles
Signed-off-by: Diego Viola <diego.viola@gmail.com>
(cherry picked from commit a78394a49a)
2024-07-05 20:00:04 +02:00
Antonio Alvarez Feijoo
a6906475be kernel-install: correct the place where it works in man and help text
(cherry picked from commit 111f988992)
2024-07-05 20:00:04 +02:00
Maximilian Wilhelm
3e435e970d man/systemd.exec: list inaccessible files for ProtectKernelTunables
(cherry picked from commit 163bb43cea)
2024-07-05 20:00:04 +02:00
pyfisch
90b5cb35e9 Use consistent spelling of systemd.condition_first_boot argument
(cherry picked from commit 051d462b42)
2024-07-05 20:00:04 +02:00
Lennart Poettering
e760157389 tmpfiles: insist on at least one configuration file being specified on --purge
Also, extend the man page explanation substantially, matching more
closely what --create says.

Fixes: #33349
(cherry picked from commit 41064a3c97)
2024-06-18 20:41:01 +02:00
Mike Yuan
1a0e6961cf man,units: drop "temporary" from description of systemd-tmpfiles
Historically, systemd-tmpfiles was designed to manager temporary
files, but nowadays it has become a generic tool for managing
all kinds of files. To avoid user confusion, let's remove "temporary"
from the tool's description.

As discussed in #33349

(cherry picked from commit b5c8cc0a3b)
2024-06-18 20:41:01 +02:00
Nick Rosbrook
aedeaf7450 man: add a bit of a warning to systemd-tmpfiles --purge
Mention that by default, /home is managed by tmpfiles.d/home.conf, and
recommend that users run systemd-tmpfiles --dry-run --purge first to
see exactly what will be removed.

(cherry picked from commit 9ebcac3b51)
2024-06-18 20:41:01 +02:00
Zbigniew Jędrzejewski-Szmek
d918804408 man/systemd: reorder content a bit
Section "Description" didn't actually say what systemd does. And we had a giant
"Concepts" section that actually described units types and other details about
them. So let's move the basic description of functionality to "Description" and
rename the following section to "Units".

The link to the Original Design Document is moved to "See Also", it is of
historical interest mostly at this point.

The only actual change is that when talking about API filesystems, /dev is also
mentioned. (I think /sys+/proc+/dev are the canonical set and should be always
listed on one breath.)

(cherry picked from commit f11aaf7dfb)
2024-06-18 20:41:01 +02:00
Zbigniew Jędrzejewski-Szmek
7b529bfc47 man: document that separate /usr/local/ must not be used for config
Since we document /usr/local/lib/systemd/ and other paths for various things,
add notes that this is not supported if /usr/local is a separate partition. In
systemd.unit, I tried to add the footnote in the table where
/usr/local/lib/systemd/ is listed, but that get's rendered as '[sup]a[/sup]'
with a mangled footnote at the bottom of the table :( .

Also, split paragraphs in one place where the subject changes without any
transition.

Follow-up for 02f35b1c90.
Replaces https://github.com/systemd/systemd/pull/33231.
2024-06-11 18:02:31 +01:00
Zbigniew Jędrzejewski-Szmek
6eddfeebdb man/systemd-soft-reboot.service: upgrade drop-in to unit file for slice
Follow-up for d91c7c91bf.
Closes https://github.com/systemd/systemd/issues/33260.
2024-06-11 10:36:50 +01:00
Luca Boccassi
d91c7c91bf man: note that templated surviving units need a drop-in for their slice
As reported on the mailing list, this is non-obvious, so document it.

https://lists.freedesktop.org/archives/systemd-devel/2024-June/050351.html
2024-06-07 12:33:18 +01:00
Jörg Behrmann
02f35b1c90 man: document /usr/local/lib in search paths 2024-06-06 12:07:08 +02:00
hanjinpeng
9246d16d3d man: mention that ExecCondition= in COMMAND LINES section for systemd.service 2024-06-02 09:23:12 +09:00