1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-23 17:34:00 +03:00
systemd-stable/docs
Daan De Meyer 4cc06b8073 docs: Add a section to HACKING.md on using mkosi and clangd together
While it's perfectly possible today to completely rely on mkosi for
building and testing systemd, to get code completion and other IDE
niceties to work properly, it's still necessary to build systemd
locally.

Recently, mkosi gained the ability to allow external programs to
communicate with the build script. We can use this feature to run
the clangd language server in the mkosi build image via a custom
build script to provide IDE features in editors without requiring
developers to build systemd on the host or install any of systemd's
build dependencies locally.

This commit adds the necessary information on how to set this up
to HACKING.md.
2021-01-24 11:14:30 +00:00
..
_data docs: beef up entrypoint documentation page 2019-12-11 10:53:14 +01:00
_includes Update copyright notice 2020-01-26 13:29:55 +09:00
_layouts docs: make it pretty 2019-12-11 17:04:20 +01:00
assets docs: make it pretty 2019-12-11 17:04:20 +01:00
fonts docs: make it pretty 2019-12-11 17:04:20 +01:00
sysvinit license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
var-log license: LGPL-2.1+ -> LGPL-2.1-or-later 2020-11-09 13:23:58 +09:00
_config.yml docs: make it pretty 2019-12-11 17:04:20 +01:00
.gitignore docs: make it pretty 2019-12-11 17:04:20 +01:00
AUTOMATIC_BOOT_ASSESSMENT.md docs: rework awkward sentence in AUTOMATIC_BOOT_ASSESSMENT 2020-08-05 19:44:37 +02:00
BLOCK_DEVICE_LOCKING.md docs: clarify that udev watches for IN_CLOSE_WRITE (and not IN_CLOSE) 2020-10-10 10:01:59 +02:00
BOOT_LOADER_INTERFACE.md docs: fix the link to boot loader specification 2020-12-30 16:04:14 +00:00
BOOT_LOADER_SPECIFICATION.md tree-wide: fix typos found by Fossies codespell report 2020-10-24 13:29:31 +02:00
CGROUP_DELEGATION.md Explain how to determine hierarchy type from shell 2020-07-10 18:52:22 +02:00
CNAME Create CNAME 2018-10-12 13:48:34 +02:00
CODE_OF_CONDUCT.md docs: drop "The" in categorization titles of Markdown documentation 2020-01-14 10:11:19 +01:00
CODE_QUALITY.md tree-wide: suggest meson command lines instead of ninja ones 2020-12-17 16:51:48 +01:00
CODING_STYLE.md docs: update coding style for return (void) func(...) 2020-10-27 00:20:17 -07:00
CONTAINER_INTERFACE.md tree-wide: update "that that" 2020-11-18 17:23:00 +09:00
CONTRIBUTING.md CONTRIBUTING: be clearer about versions and RFE process 2020-08-31 23:23:56 +02:00
CONVERTING_TO_HOMED.md Update the rsync command in CONVERTING_TO_HOMED 2020-05-06 10:52:22 +02:00
DESKTOP_ENVIRONMENTS.md docs: Document xdg-autostart parameter X-systemd-skip 2020-07-20 16:03:47 +02:00
DISCOVERABLE_PARTITIONS.md doc: add missing comma in DISCOVERABLE_PARTITIONS.md 2021-01-06 16:18:54 +01:00
DISTRO_PORTING.md docs: make it pretty 2019-12-11 17:04:20 +01:00
ENVIRONMENT.md man: add man page for systemd-sysext 2021-01-19 13:41:42 +01:00
favicon.png docs: make it pretty 2019-12-11 17:04:20 +01:00
favicon.svg docs: make it pretty 2019-12-11 17:04:20 +01:00
GROUP_RECORD.md docs: document new description field 2020-08-07 08:39:56 +02:00
HACKING.md docs: Add a section to HACKING.md on using mkosi and clangd together 2021-01-24 11:14:30 +00:00
HOME_DIRECTORY.md tree: wide "the the" and other trivial grammar fixes 2020-07-02 09:51:38 +02:00
index.md docs: fix width of console example 2020-01-15 13:46:16 +01:00
INITRD_INTERFACE.md tree: wide "the the" and other trivial grammar fixes 2020-07-02 09:51:38 +02:00
JOURNAL_FILE_FORMAT.md JOURNAL_FILE_FORMAT: fixup typos and punctuation 2020-11-18 09:29:58 +01:00
PASSWORD_AGENTS.md docs: add some backticks and more formatting to PASSWORD_AGENTS.md (#15803) 2020-05-13 14:52:09 +02:00
PORTABILITY_AND_STABILITY.md tree-wide: update web link to logind description 2020-10-19 15:23:37 +02:00
PORTABLE_SERVICES.md docs: import discoverable partitions spec 2019-12-23 14:44:33 +01:00
PREDICTABLE_INTERFACE_NAMES.md Merge pull request #14308 from poettering/man-naming-scheme-typo 2019-12-12 17:04:06 +09:00
RANDOM_SEEDS.md tree: wide "the the" and other trivial grammar fixes 2020-07-02 09:51:38 +02:00
RELEASE.md tree-wide: suggest meson command lines instead of ninja ones 2020-12-17 16:51:48 +01:00
RESOLVED-VPNS.md docs: document what VPNs should do to systemd-resolved.service 2020-11-25 14:08:37 +01:00
ROOT_STORAGE_DAEMONS.md docs: update old documentation links 2020-09-29 21:45:06 +02:00
SECURITY.md docs: policy for systemd-security subscriptions 2020-05-15 20:40:58 +02:00
style.css docs: CSS files should not be executable 2019-12-16 09:50:02 +01:00
TEMPORARY_DIRECTORIES.md man: use paragraphs in descriptions of /tmp and /var/tmp 2020-10-05 18:38:35 +02:00
TESTING_WITH_SANITIZERS.md docs: uppercase all markdown document titles 2020-01-14 10:14:11 +01:00
TRANSIENT-SETTINGS.md timer: add new feature FixedRandomDelay= 2020-11-05 10:59:33 -08:00
TRANSLATORS.md tree-wide: suggest meson command lines instead of ninja ones 2020-12-17 16:51:48 +01:00
UIDS-GIDS.md Look at /etc/login.defs for the system_max_[ug]id values 2020-10-01 17:49:31 +02:00
USER_GROUP_API.md man: document new varlink service 2020-07-14 17:08:12 +02:00
USER_NAMES.md tree-wide: avoid some loaded terms 2020-06-25 09:00:19 +02:00
USER_RECORD.md docs: document new recovery key user record fields 2020-08-25 18:14:55 +02:00
USERDB_AND_DESKTOPS.md docs: use "polkit" to refer to PolicyKit 2020-04-21 17:10:02 +02:00