From 026d249969c315c9b96cb682c22db363542bb3d8 Mon Sep 17 00:00:00 2001 From: William Roberts Date: Tue, 25 Oct 2022 09:09:29 -0500 Subject: [PATCH] docs/HACKING.md: clarify some portions Clarify portions of HACKING.md so folks don't spend as much time as I did on it. Signed-off-by: William Roberts --- docs/HACKING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/HACKING.md b/docs/HACKING.md index 42874033b5..979cd58407 100644 --- a/docs/HACKING.md +++ b/docs/HACKING.md @@ -303,8 +303,10 @@ To simplify debugging systemd when testing changes using mkosi, we're going to s To allow VSCode's debugger to attach to systemd running in a mkosi image, we have to make sure it can access the container/virtual machine spawned by mkosi where systemd is running. mkosi makes this possible via a -handy SSH option that makes the generated image accessible via SSH when booted. The easiest way to set the -option is to create a file 20-local.conf in mkosi.default.d/ and add the following contents: +handy SSH option that makes the generated image accessible via SSH when booted. Thus you must build +the image with `mkosi --ssh`. The easiest way to set the +option is to create a file 20-local.conf in mkosi.default.d/ (in the directory you ran mkosi in) and add +the following contents: ``` [Host] @@ -327,8 +329,8 @@ corresponding parts of the C/C++ extension in your VSCode user settings by addin ``` With the extension set up, we can create the launch.json file in the .vscode/ directory to tell the VSCode -debugger how to attach to the systemd instance running in our mkosi container/VM. Create the file and add the -following contents: +debugger how to attach to the systemd instance running in our mkosi container/VM. Create the file, and possibly +the directory, and add the following contents: ```json {