1
0
mirror of https://github.com/systemd/systemd.git synced 2024-12-22 17:35:35 +03:00
Commit Graph

8797 Commits

Author SHA1 Message Date
Yu Watanabe
d51236d833 man: several more assorted fixes
Continuation of 4ebbb5bfe8.
Closes #35307.

(cherry picked from commit f29a07f3fc)
2024-11-29 14:26:57 +01:00
Winterhuman
09accdb68c man/systemd-system.conf: Correct "struct" to "strict" (#35364)
(cherry picked from commit 5bed97dd57)
2024-11-29 14:26:56 +01:00
Yu Watanabe
6f2483eed8 man: use MIT-0 license for example codes in daemon(7)
This page contains many short example codes. I do not think we should
add SPDX-License-Identifier for all codes.

Closes #35356.

(cherry picked from commit 6046cc3660)
2024-11-29 14:26:56 +01:00
Yu Watanabe
8cca30da53 man: update documentation about basic .netdev file handling
Follow-up for #34909 and later PRs.

(cherry picked from commit d07fbf22ed)
2024-11-29 14:26:56 +01:00
Yu Watanabe
95f9307b65 man: asorted fixes
Closes #35307.

(Changes to files with conflicts were dropped.)
(cherry picked from commit 4ebbb5bfe8)
2024-11-29 14:26:56 +01:00
Antonio Alvarez Feijoo
03b993a9bf man/kernel-command-line: fix typo
(cherry picked from commit a04d42821b)
2024-11-28 15:05:52 +01:00
Štěpán Němec
1bc1a5ea7e man/systemd.special: fix a typo
(cherry picked from commit 62ec4798f2)
2024-11-13 19:48:10 +00:00
Štěpán Němec
a07693cda5 man: fix incorrect volume numbers in internal man page references
Some ambiguity (e.g., same-named man pages in multiple volumes)
makes it impossible to fully automate this, but the following
Python snippet (run inside the man/ directory of the systemd repo)
helped to generate the sed command lines (which were subsequently
manually reviewed, run and the false positives reverted):

from pathlib import Path

import lxml
from lxml import etree as ET

man2vol: dict[str, str] = {}
man2citerefs: dict[str, list] = {}

for file in Path(".").glob("*.xml"):
    tree = ET.parse(file, lxml.etree.XMLParser(recover=True))
    meta = tree.find("refmeta")
    if meta is not None:
        title = meta.findtext("refentrytitle")
        if title is not None:
            vol = meta.findtext("manvolnum")
            if vol is not None:
                man2vol[title] = vol
            citerefs = list(tree.iter("citerefentry"))
            if citerefs:
                man2citerefs[title] = citerefs

for man, refs in man2citerefs.items():
    for ref in refs:
        title = ref.findtext("refentrytitle")
        if title is not None:
            has = ref.findtext("manvolnum")
            try:
                should_have = man2vol[title]
            except KeyError:  # Non-systemd man page reference?  Ignore.
                continue
            if has != should_have:
                print(
                    f"sed -i '\\|<citerefentry><refentrytitle>{title}"
                    f"</refentrytitle><manvolnum>{has}</manvolnum>"
                    f"</citerefentry>|s|<manvolnum>{has}</manvolnum>|"
                    f"<manvolnum>{should_have}</manvolnum>|' {man}.xml"
                )

(cherry picked from commit 597c6cc119)
2024-11-13 19:48:10 +00:00
Zbigniew Jędrzejewski-Szmek
4cafd1a21f man: drop whitespace from final <programlisting> lines
In the troff output, this doesn't seem to make any difference. But in the
html output, the whitespace is sometimes preserved, creating an additional
gap before the following content. Drop it everywhere to avoid this.

(cherry picked from commit fe45f8dc9b)
2024-11-13 19:48:10 +00:00
Yu Watanabe
4d574b106f man/udev: fix typo
Follow-up for df8f9b88bd.

(cherry picked from commit 9dcf5c226e)
2024-11-13 19:48:10 +00:00
Lennart Poettering
d4d7aa60e1 man: convert multiple left-over "See Also" sections to <simplelist>
These were forgotten during the initial conversion, probably because
most of them consisted only of a single entry.

Fix that.

(cherry picked from commit df8f9b88bd)
2024-11-13 19:48:10 +00:00
Lennart Poettering
d9ab18e747 man: link up D-Bus API docs from daemon man pages
Let's systematically make sure that we link up the D-Bus interfaces from
the daemon man pages once in prose and once in short form at the bottom
("See Also"), for all daemons.

Also, add reverse links at the bottom of the D-Bus API docs.

Fixes: #34996
(cherry picked from commit 607d297487)
2024-11-13 19:48:10 +00:00
Lennart Poettering
ea8b10409b man: point people from sd-bus man page to busctl
(cherry picked from commit 2f69ad26ca)
2024-11-13 19:48:10 +00:00
Lennart Poettering
307a6332a6 man: tone down claims on processes having exited already in ExecStop=
Processes can easily survive the first kill operation we execute, hence
we shouldn't make strong claims about them having exited already. Let's
just say "likely" hence.

Fixes: #15032
(cherry picked from commit ac804bc2f8)
2024-11-13 19:48:10 +00:00
Lennart Poettering
a6f9c20316 man: document that .path units don't care for hidden files
Fixes: #32751
(cherry picked from commit 5adc433799)
2024-11-13 19:48:10 +00:00
Lennart Poettering
48559a0b22 man: document that PrivateTmp= is unaffected by ProtectSystem=strict
Fixes: #33130
(cherry picked from commit b711737096)
2024-11-13 19:48:10 +00:00
Lennart Poettering
5a2ffc543b man: don't claim SELinuxContext= only worked in the system service manager
Fixes: #34840
(cherry picked from commit ecbe9ae5a0)
2024-11-13 19:48:10 +00:00
Lennart Poettering
f792b8020b man: document the timeout applied to /usr/lib/systemd/system-shutdown/ drop-in binaries
Fixes: #34949
(cherry picked from commit af080967ba)
2024-11-13 19:48:10 +00:00
Antonio Alvarez Feijoo
7a369c3971 man/veritysetup-generator: document veritytab kernel command line option
(cherry picked from commit e98e3f856d)
2024-11-13 19:48:10 +00:00
Antonio Alvarez Feijoo
139106140e man: fix links to veritysetup(8)
(cherry picked from commit dcbfc7872e)
2024-11-13 19:48:10 +00:00
Zbigniew Jędrzejewski-Szmek
a816075978 man/systemd-nspawn: emphasise that user namespaces are strongly recommended
(cherry picked from commit 9b1a5bc365)
2024-11-13 19:48:10 +00:00
Lennart Poettering
ff667d8c2e man: reword comment a bit regarding ExecStartPre= multiple commands
The documentation claimed that ExecStartPre=/ExecStartPost= accepts
multiple command lines, in contrast to ExecStart=. This is half an
untruth, because ExecStart= allows that too – as long as Type=oneshot is
set.

Hence, reword this a bit, and do not emphasize the contrast.

Prompted by: #34570

(cherry picked from commit c3069a6bfb)
2024-11-13 19:48:10 +00:00
David Joaquín Shourabi Porcel
697d247e30 man: machinectl(1): Fix description of subcommand poweroff
(cherry picked from commit a41da1e703)
2024-11-13 19:48:10 +00:00
David Joaquín Shourabi Porcel
5a2f94d2da man: systemd-nspawn(1): Fix some typos
(cherry picked from commit f4e3c6e5b3)
2024-11-13 19:48:10 +00:00
Jörg Behrmann
5b5f5666b2 man: Use proper conjunction and remove superfluous or
(cherry picked from commit 56f32d9e78)
2024-10-08 16:39:12 +01:00
Luca Boccassi
1075727f7f man: consolidate list of active unit states into a shared table
Avoids the need to maintain the same list over and over again, and
link it to the defition table in the implementation as a reminder
too

(cherry picked from commit 3509fe124d)
2024-10-08 16:39:12 +01:00
Lukas Nykryn
adc57cd81c man: using WantedBy=default.target is not a good idea
We had several users, that wrote their unit files with
WantedBy=default.target because it should be started "every time".
But for example in Fedora/CentOS/RHEL, this often breaks for
example selinux relabels (where we just want to do a relabel and reboot).

(cherry picked from commit 67b6404b80)
2024-10-08 16:39:12 +01:00
Lennart Poettering
96c0549bda man: drop reference to /bin/ from docs regarding binary search path
We don't support "split /usr" systems anymore, hence no point in
mentioning /bin/ anymore as being part of the binary search path.

(cherry picked from commit f39e66b85a)
2024-10-08 16:39:12 +01:00
Lennart Poettering
aeda397aed man: soft deprecate use of ";" for separating multiple command lines in ExecStart=
So far we supported this syntax:

    ExecStart=foo ; bar

as equivalent to:

    ExecStart=foo
    ExecStart=bar

With this change we'll "soft" deprecate the first syntax. i.e. it's
still supported in code, but not documented anymore.

The concept was originally added to make things easier for 3rd party
.ini readers, as it allowed writing unit files with a .ini framework
that doesn't allow multiple assignments for the same key. But frankly,
this is kinda pointless, as so many other of our knobs require the
double assignment.

Hence, let's just stop advertising the concept, let's simplify the docs,
by removing one entirely redundant feature from it.

Replaces: #34570
(cherry picked from commit 225f18b9a9)
2024-10-08 16:39:12 +01:00
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