]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
README: Mention meson subprojects update
authorDaniel Wagner <dwagner@suse.de>
Tue, 8 Feb 2022 15:30:41 +0000 (16:30 +0100)
committerDaniel Wagner <dwagner@suse.de>
Thu, 3 Mar 2022 17:42:33 +0000 (18:42 +0100)
New meson users are not aware of this rather nifty update
mechanism. Mention it in the README.

While at it also mention the library dependency.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
README.md

index 2663869a72565dccf22cfeccb22caa9647931b3d..f8aa9a13d1de6a0819ddb3d26ca495c9a09edd0a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ run following commands
        $ meson .build
        $ ninja -C .build
 
+nvme-cli depends on zlib, json-c and libuuid.
+
 To install, run:
 
        # meson install -C .build
@@ -236,3 +238,15 @@ File: foo-plugin.c
 
 After that, you just need to implement the functions you defined in each
 ENTRY, then append the object file name to the meson.build "sources".
+
+## meson tips
+
+In case meson doesn't find libnvme header files (via pkg-config) it
+will fallback using subprojects. meson checks out libnvme in
+subprojects directory as git tree once and will not modify libnvme
+unless explicitly told. That means the current branch is updated via
+git, the subprojects/libnvme branch will not updated accordingly. So
+either update it via normal git operations or
+
+    $ meson subprojects update
+