]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs/HACKING.md: clarify some portions
authorWilliam Roberts <william.c.roberts@intel.com>
Tue, 25 Oct 2022 14:09:29 +0000 (09:09 -0500)
committerLuca Boccassi <luca.boccassi@gmail.com>
Mon, 31 Oct 2022 19:56:37 +0000 (20:56 +0100)
Clarify portions of HACKING.md so folks don't spend as much time as I
did on it.

Signed-off-by: William Roberts <william.c.roberts@intel.com>
docs/HACKING.md

index 42874033b5407dd1d86cd03dc2e0ae678bf7e7de..979cd58407a80628b50f4efafd58665750dc71d2 100644 (file)
@@ -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
 {