Commit Graph

385 Commits

Author SHA1 Message Date
Lennart Poettering 6b000af4f2 tree-wide: avoid some loaded terms
https://tools.ietf.org/html/draft-knodel-terminology-02
https://lwn.net/Articles/823224/

This gets rid of most but not occasions of these loaded terms:

1. scsi_id and friends are something that is supposed to be removed from
   our tree (see #7594)

2. The test suite defines an API used by the ubuntu CI. We can remove
   this too later, but this needs to be done in sync with the ubuntu CI.

3. In some cases the terms are part of APIs we call or where we expose
   concepts the kernel names the way it names them. (In particular all
   remaining uses of the word "slave" in our codebase are like this,
   it's used by the POSIX PTY layer, by the network subsystem, the mount
   API and the block device subsystem). Getting rid of the term in these
   contexts would mean doing some major fixes of the kernel ABI first.

Regarding the replacements: when whitelist/blacklist is used as noun we
replace with with allow list/deny list, and when used as verb with
allow-list/deny-list.
2020-06-25 09:00:19 +02:00
Lennart Poettering 18d9cee002 man: document systemd.random-seed= 2020-06-24 15:33:48 +02:00
Lennart Poettering 21385e639a man: replace perl bug tracker link that went away with link to paper
Fixes: #16245
2020-06-23 17:19:05 +02:00
Luca Boccassi 34e0d56ce2 Container interface: document exposing the host's os-release
In order to allow applications to detect the host OS version or other
metadata, ask container managers to expose the os-release files as
read-only bind mounts.
For systemd-nspawn, we will also expose ID, BUILD_ID, VERSION_ID and
VARIANT_ID as lowercase environment variables prefixed by the
container_host_ string.
2020-06-23 12:57:05 +01:00
Lennart Poettering ffc8eeae62 USER_RECORD: fix typo
Fixes: #16172
2020-06-16 20:24:32 +02:00
Evgeny Vereshchagin 135a1add7b turn off fuzzit part 2
it's just a follow-up to https://github.com/systemd/systemd/pull/16064
2020-06-11 18:59:44 +02:00
David Edmundson 6a881daf85 docs: Change suffix for desktop applications to support non-transient services
One problem found with the current draft specification is we can't have
an application provide a non-transient systemd service file in a way
that is spec compliant as the service name currently needs to end in a
random token defined by the launcher.

This came up when trying to put DBus activated services into the correct
cgroup. There isn't enough metadata in the DBus service file to know the
correct application ID, and the most intuitive fix is for those
applications to just specify the SystemdService file in the existing
system. They're generally unique for a given user session anyway so
don't need a separate cgroup identifier.

This changes the spec for RANDOM to be optional for services.

It also changes the separator between in services to act like templates.
Ultimately that's what we're trying to recreate with the RANDOM token of
the systemd service and it's a better fit. It's needed as otherwise with
launcher and the random ident being both optional it would be impossible
to get the application ID reliably.

Scopes are unchanged as they don't support templates.
2020-06-10 17:10:57 +02:00
Lennart Poettering c85b6ff1b2 docs: point contributors to list of most recent systemd releases
Fixes: #16083
2020-06-10 10:30:02 +02:00
Michał Bartoszkiewicz fa0e23c900 docs: use bool in varlink interface definition
Boolean type in varlink is named bool, not boolean.
2020-06-09 17:11:38 +02:00
Lennart Poettering a3d19f5d99 core: add new PassPacketInfo= socket unit property 2020-05-27 22:40:38 +02:00
Daniel Fullmer e6190e2882 sd-boot: fix menu ordering with boot counting
systemd-boot selects the last valid entry by default, not the first.

Fixes: #15256
2020-05-26 19:27:59 +02:00
Zbigniew Jędrzejewski-Szmek 201632e314 tree-wide: s/time-out/timeout/g
See 3f9a0a522f for justification.
2020-05-26 10:28:59 +02:00
Evgeny Vereshchagin 2f0a427b45 docs: add a link to the Fossies codespell report 2020-05-21 09:00:53 +02:00
Zbigniew Jędrzejewski-Szmek bb94ded693
Merge pull request #15661 from hundeboll/mount-read-write-only
Mount read write only
2020-05-20 15:48:04 +02:00
Martin Hundebøll 75f4bd7fd0 man: document ReadWriteOnly property for mount units 2020-05-20 14:26:04 +02:00
Zbigniew Jędrzejewski-Szmek 154962d348 docs: policy for systemd-security subscriptions
Replaces #14325.
2020-05-15 20:40:58 +02:00
Дамјан Георгиевски 5a0173147b
docs: add some backticks and more formatting to PASSWORD_AGENTS.md (#15803)
docs: add some backticks and more formatting to PASSWORD_AGENTS.md
2020-05-13 14:52:09 +02:00
Дамјан Георгиевски 8623836502 fix WikiWord not-links 2020-05-13 04:56:50 +02:00
Дамјан Георгиевски 67a40f217c docs: import password agents documentation
imported from:
https://cgit.freedesktop.org/wiki/www/plain/Software/systemd/PasswordAgents.mdwn
2020-05-12 20:31:44 +02:00
Lennart Poettering c0440512e6 docs: document the new offline discard logic 2020-05-07 16:13:07 +02:00
Gergely Polonkai c28904dae0 Update the rsync command in CONVERTING_TO_HOMED
The old version of this command will delete everything under the new home directory (including `.identity`), rendering the directory unusable with homed.
2020-05-06 10:52:22 +02:00
Benjamin Berg 60ca8f22b8 docs: Change prefix for desktop applications to app-
We need both a slice name and a prefix for application units. For
consistency we tried to use the same name and ended up standardising on
"apps.slice" and and "apps-" prefix for the units.

However, "app-" would be a more natural prefix for applications. And it
is no problem to simply also name the slice "app.slice" for consistency
rather than keeping the current "apps.slice".
2020-04-30 14:21:44 +02:00
Zbigniew Jędrzejewski-Szmek f20078df0b docs: reorder the section about security reporting to emphasize the sekrit list 2020-04-29 17:20:37 +02:00
Lennart Poettering a9ab5cdb50
Merge pull request #15472 from keszybz/dbus-api-docs
A few more dbus api documentation updates
2020-04-23 17:01:11 +02:00
Frantisek Sumsal 86b52a3958 tree-wide: fix spelling errors
Based on a report from Fossies.org using Codespell.

Followup to #15436
2020-04-21 23:21:08 +02:00
Zbigniew Jędrzejewski-Szmek 98ab0daeeb docs: use "polkit" to refer to PolicyKit
See d35f51ea84 for justification.

First use in each file is turned into a link to the documentation page.
2020-04-21 17:10:02 +02:00
Zbigniew Jędrzejewski-Szmek 38b38500c6 tree-wide: use "hostname" spelling everywhere
It's not that I think that "hostname" is vastly superior to "host name". Quite
the opposite — the difference is small, and in some context the two-word version
does fit better. But in the tree, there are ~200 occurrences of the first, and
>1600 of the other, and consistent spelling is more important than any particular
spelling choice.
2020-04-21 16:58:04 +02:00
Lennart Poettering 5fe63895b9 docs: introduce documentation category for user/group stuff
We have so many different docs on various facets of user/group stuff,
let's add our own category for it.
2020-04-11 18:03:24 +02:00
Lennart Poettering b05e122036 docs: add some documentation about hooking up userdb/homed to desktop environments
Prompted by some inquires from the GNOME camp. let's document this here,
since other DEs might be interested too.
2020-04-10 18:54:58 +02:00
Lennart Poettering 5a3033321a docs: add brief document how to convert home directories to homed 2020-04-10 15:57:29 +02:00
Lennart Poettering 10eed9848d docs: fix typo now → not 2020-04-09 19:26:36 +02:00
Lennart Poettering b27cb676bf docs: add missing dash 2020-04-09 19:24:44 +02:00
Lennart Poettering 9b3c65ed36
Merge pull request #15352 from poettering/user-group-name-valdity-rework
user/group name validity rework
2020-04-09 18:49:22 +02:00
Zbigniew Jędrzejewski-Szmek ad21e542b2 manager: add CoredumpFilter= setting
Fixes #6685.
2020-04-09 14:08:48 +02:00
Lennart Poettering 887a8fa341 docs: hook up the new USER_NAMES document everywhere
(Also correct the set of names we accept in User=, which was forgotten
to be updated in ae480f0b09.
2020-04-08 17:30:04 +02:00
Lennart Poettering cafed7b32c docs: add a longer document explaining our rules on user/group names 2020-04-08 17:30:04 +02:00
Benjamin Berg 31c68e0277 docs: Add some notes about managing graphical user sessions
This is work in progress and not finished yet. However, I hope to have
captured some of the key points that came up in previous discussions
with appropriate notes about things that still need to be defined.

I may revisit it later. Also, feel free to completely rewrite if the
format is not quite right.
2020-03-27 21:57:44 +01:00
Lucas Werkmeister e1ef1e5d53 docs: fix typo 2020-03-06 22:58:53 +01:00
Lucas Werkmeister afcb3e758c docs: fix misplaced close-paren
I assume it’s supposed to be “see Home Directories for details” and not
“… and embeds these JSON records directly in the home directory images …
for details”, but the previous text suggested the latter reading to me.
2020-03-06 22:12:37 +01:00
Zbigniew Jędrzejewski-Szmek 870d38dca9 docs: add .link/.network/.netdev files to interface stability chart
Fixes #9850.
2020-03-03 19:11:45 +01:00
Zbigniew Jędrzejewski-Szmek b0cda24148 docs: interlink the docs to make it easier to navigate 2020-02-28 16:54:33 +01:00
Zbigniew Jędrzejewski-Szmek 04c31af4c5 docs: say XBOOTLDR instead of just giving the GPT identifier
Fixes #14832.

Also, say "MBR partition table" and not "MBR disk label". "disk label" doesn't
seem to mean anything.
2020-02-28 16:54:33 +01:00
Lynn Kirby 6cec69fc3e Change all fuzzing links to point to OSS-Fuzz site 2020-02-18 01:50:36 +03:00
Lynn Kirby 129c55c06f docs: fix HACKING.md broken links 2020-02-18 01:50:36 +03:00
Michal Koutný 8b51950f4c docs: Correct resource weight range 2020-02-05 16:58:07 +00:00
Wilhelm Schuster faec9de87f docs: Fix example code in ROOT_STORAGE_DAEMONS 2020-01-30 20:27:05 +00:00
mtron 58345a2332
docs: formatting fix (#14707)
fixes formatting in the last paragraph of the 'General Structure' chapter.
2020-01-31 00:06:57 +09:00
mtron 56b3eddb70 fix links to GROUP_RECORD and USER_GROUP_API
fix 2 more broken links. 

GROUP_RECORD now points to https://systemd.io/GROUP_RECORD/ and 
USER_GROUP_API to https://systemd.io/USER_GROUP_API/
2020-01-30 23:48:44 +09:00
mtron e5e529c30a fix link to JSON User Records 2020-01-30 23:32:17 +09:00
Lennart Poettering a9dabd6866 docs: document the home directory format 2020-01-28 22:38:17 +01:00
Lennart Poettering f62dd2375e docs: document homed UID range 2020-01-28 22:38:13 +01:00
Lennart Poettering b940fb1f4f
Merge pull request #14594 from keszybz/id128-show-gpt
Print gpt table values in systemd-id128
2020-01-28 17:23:50 +01:00
Ashley Davis 8bc943b472 fix erroneous "`" in boot loader spec 2020-01-29 00:52:54 +09:00
Lennart Poettering 766840af42
Merge pull request #14673 from keur/protect_clock
Protect clock
2020-01-28 15:11:41 +01:00
Kevin Kuehler 022d334561 man: doc: Document ProtectClock= 2020-01-27 11:21:36 -08:00
WataruMatsuoka 576e50efb6 Update copyright notice 2020-01-26 13:29:55 +09:00
Zbigniew Jędrzejewski-Szmek dc972b0740 systemd-id128: add new verb to print GPT partitions UUIDs 2020-01-23 23:32:13 +01:00
Emmanuel Bourg d3e5639ebb Fixed some typos in the documentation 2020-01-21 15:07:19 +01:00
Lennart Poettering 1e1f4f443d docs: uppercase are headers
We do this in most cases, do so here too.
2020-01-17 10:09:50 +01:00
Lennart Poettering 3b9796c01c docs: let's reduce our spurious whitespace a bit 2020-01-17 10:09:50 +01:00
Lennart Poettering 8eabc083dc docs: in PORTABILITY_AND_STABILITY only use one h1
According to the designer of the page layout a page only should have one
h1 header, and everything else should be h2, h3, … I think that makes a
ton of sense, hence let's downgrade some headers here.
2020-01-17 10:09:50 +01:00
Lennart Poettering 8384ed93b9 docs: clarify that we don't want to own $BOOT exclusively
Let's be clearer here.

Prompted by a quick discussion I had with @gicmo.
2020-01-17 10:08:13 +01:00
Lennart Poettering c903ee8976 docs: add documentation for the varlink user/group APIs 2020-01-15 15:34:09 +01:00
Lennart Poettering 32eb3c4229 docs: add documentation for JSON group records, too 2020-01-15 15:34:09 +01:00
Lennart Poettering 812862db71 docs: add documentation for JSON user records 2020-01-15 15:34:09 +01:00
Lennart Poettering 42f3b2f975 shared: split out crypt() specific helpers into its own .c/.h in src/shared/
This way we can use libxcrypt specific functionality such as
crypt_gensalt() and thus take benefit of the newer algorithms libxcrypt
implements. (Also adds support for a new env var $SYSTEMD_CRYPT_PREFIX
which may be used to select the hash algorithm to use for libxcrypt.)

Also, let's move the weird crypt.h inclusion into libcrypt.h so that
there's a single place for it.
2020-01-15 15:26:27 +01:00
Zbigniew Jędrzejewski-Szmek 65e2766f64 docs: fix width of console example 2020-01-15 13:46:16 +01:00
Zbigniew Jędrzejewski-Szmek 5425f8a57c Revert "docs: rename HACKING → Hacking"
This reverts commit 8c5cd27dd1.
2020-01-15 13:45:04 +01:00
Zbigniew Jędrzejewski-Szmek 8c5cd27dd1 docs: rename HACKING → Hacking
Let's see if this works at all.
2020-01-15 12:38:12 +01:00
Zbigniew Jędrzejewski-Szmek b6bcde2623 docs: shift console log on index page to the left 2020-01-15 11:58:08 +01:00
Zbigniew Jędrzejewski-Szmek 6af0a04428 docs: add the systemd output example
It is still nice...
2020-01-15 08:57:37 +01:00
Zbigniew Jędrzejewski-Szmek 4e96d758f8 docs: update old para with links to the blog stories
They are of historical interest, but without links not very useful.
2020-01-15 08:57:37 +01:00
Zbigniew Jędrzejewski-Szmek 48f60ea9ad docs: remove markup from title
Github uses a different background for backticked text, and this stands out
(in a bad way) on the title page.
2020-01-15 08:57:37 +01:00
Lennart Poettering 3fec552468 docs: rework HTML into GitHub Markdown table
Presumably this should render better on https://systemd.io/DISCOVERABLE_PARTITIONS then.

As pointed out on: https://github.com/systemd/systemd/pull/14390#issuecomment-574205631
2020-01-14 16:58:05 +01:00
Lennart Poettering 550979c8ae
Merge pull request #14570 from keszybz/resource-docs
Modernize links to cgroups docs
2020-01-14 16:17:38 +01:00
Zbigniew Jędrzejewski-Szmek ea7fe1d1c2
Merge pull request #14390 from poettering/gpt-var-tmp
introduce GPT partition types for /var and /var/tmp and support them for auto-discovery
2020-01-14 15:37:53 +01:00
Lennart Poettering b35ec8ded2 docs: uppercase all markdown document titles
For most we used uppercasing, but not for all. Let's stick to one rule,
and uppercase them all.
2020-01-14 10:14:11 +01:00
Lennart Poettering a0fadf66da docs: drop "The" in categorization titles of Markdown documentation
I think it makes sense to keep the "The" in place for the actual page's
title, but let's drop it from the categorization header, to make it
easier to find stuff, as the "The" isn't helpful to that.

In particular as we sometimes do it this and sometimes the other way so
far, hence let's stick to one common rule.
2020-01-14 10:11:19 +01:00
Zbigniew Jędrzejewski-Szmek 744c49e1fe docs: update link and more dots
Apparently unicode ellipsis is too much for github.
2020-01-13 21:03:15 +01:00
Zbigniew Jędrzejewski-Szmek 0a5a8f13b4 docs: say that journalctl --flush/--sync also require journald
https://github.com/systemd/systemd/pull/14549#pullrequestreview-341758182
2020-01-13 21:01:01 +01:00
Zbigniew Jędrzejewski-Szmek 89f3ba7995
Merge pull request #14557 from poettering/root-storage-daemons-markdown
docs: convert root storage daemon doc to markdown
2020-01-13 20:57:37 +01:00
Lennart Poettering 180f7c26aa docs: import initrd interface documentation from fdo wiki
Imported from https://www.freedesktop.org/wiki/Software/systemd/InitrdInterface/
2020-01-13 20:55:57 +01:00
Lennart Poettering f8349d2fa5 docs: various small fixes to PORTABILITY_AND_STABILITY markdown
Nothing particularly world moving.

Follow-up for #14549
2020-01-13 20:12:12 +01:00
Lennart Poettering 6e47cac0aa docs: convert root storage daemon doc to markdown
Import from:

https://www.freedesktop.org/wiki/Software/systemd/RootStorageDaemons/
2020-01-13 18:52:56 +01:00
Zbigniew Jędrzejewski-Szmek d89cde0994 docs: say that various cli progs are independent of pid1 2020-01-12 19:12:15 +01:00
Zbigniew Jędrzejewski-Szmek ef0bea8cf4 docs: say that dbus api is stable (but list various caveats)
I removed the part about sysv compat, because that has already been removed and
we don't make any use of conditional dbus interfaces afaict.
2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek b2eea3dc32 docs: say that all documented programs in $PATH are stable 2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek e4893c6306 docs: import "interface stability promise"
In the wiki, this was a separate page. I don't think this split is useful,
since the information about what is stable and what not seems randomly split
between the two pages.

Links are adjusted for our own pages. Some external links to gentoo and other
projects seem to be broken, but it's a chore to fix them.
2020-01-12 18:54:17 +01:00
Zbigniew Jędrzejewski-Szmek b8b7309778 docs/stability: relax the stance on accepting patches a bit
Instead of saying that patches for portability are not accepted, say that this
is decided case-by-case. This is what happens in practice, and we tend to
discuss each patch on its own merits.

Some sentences are reworded a bit where they sound awkward.
2020-01-11 19:20:35 +01:00
Zbigniew Jędrzejewski-Szmek 02c789f9f9 docs: import stability chart from wiki 2020-01-11 18:47:26 +01:00
Zbigniew Jędrzejewski-Szmek bb6d563a50 doc: link to html versions of cgroup docs
Also stop linking to some (obsolete) v1 documentation.
2020-01-09 16:47:34 +01:00
Zbigniew Jędrzejewski-Szmek d2e825b4ab doc: tweak grammar in CONTAINER_INTERFACE description
The only non-stylistic change is to replace descriptions of how we are
encouraging people to use PrivateTmp= and such, because now they are widely
used.
2020-01-08 10:29:10 +01:00
Lennart Poettering 635dea2783 docs: move container interface docs from wiki to markdown
Let's move
https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/
into our tree and convert it to Markdown.

This also incldues some minor fixes and other changes.
2020-01-06 18:12:22 +01:00
Lennart Poettering 19ac32cdd6 docs: import discoverable partitions spec
This was previously available here:

https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/

Let's pull it into our repository.
2019-12-23 14:44:33 +01:00
Lennart Poettering da7667518b docs: CSS files should not be executable 2019-12-16 09:50:02 +01:00
Lennart Poettering ff2c2d0850 docs: make sure there's only one # markdown header in each file
@bertob wants us to be strict here, and only have one "#" header per
markdown file, and use "##" (or "###", …) for all others. Interestingly,
we mostly got this right already, but this fixes a few cases where this
wasn't correct.
2019-12-13 11:56:08 +01:00
Yu Watanabe da1b880a3a
Merge pull request #14308 from poettering/man-naming-scheme-typo
superficial fixes to network naming docs
2019-12-12 17:04:06 +09:00
Tobias Bernard b41a3f66c9 docs: make it pretty
Add custom Jekyll theme, logo, webfont and .gitignore

FIXME: the markdown files have some H1 headers which need to be replaced
with H2
2019-12-11 17:04:20 +01:00
Lennart Poettering 7c4a7c6d13 docs: fix markdown links 2019-12-11 12:08:59 +01:00
Lennart Poettering 471d407eaa docs: use `` quotes for marking identifiers of some form 2019-12-11 12:08:55 +01:00