docs/manual: add some minimal documentation about show-info and pkg-stats
authorThomas Petazzoni <thomas.petazzoni@bootlin.com>
Thu, 5 Nov 2020 16:30:23 +0000 (17:30 +0100)
committerPeter Korsgaard <peter@korsgaard.com>
Wed, 11 Nov 2020 11:09:41 +0000 (12:09 +0100)
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
docs/manual/common-usage.txt

index 7cfda10365d5eaf2f92e3f907233a9bb9038e131..9ba87a83399cbe17060e6dfe4cc119c7b922c837 100644 (file)
@@ -157,6 +157,29 @@ your filesystem, those parts may not be all-zeroes when read back). You
 should only use sparse files when handling files on the build machine, not
 when transferring them to an actual device that will be used on the target.
 
+=== Details about packages
+
+[[package-details]]
+
+Buildroot can produce a JSON blurb that describes the set of enabled
+packages in the current configuration, together with their
+dependencies, licenses and other metadata. This JSON blurb is produced
+by using the +show-info+ make target:
+
+------------------------
+make show-info
+------------------------
+
+Buildroot can also produce details about packages as HTML and JSON
+output using the +pkg-stats+ make target. Amongst other things, these
+details include whether known CVEs (security vulnerabilities) affect
+the packages in your current configuration. It also shows if there is
+a newer upstream version for those packages.
+
+------------------------
+make pkg-stats
+------------------------
+
 === Graphing the dependencies between packages
 
 [[graph-depends]]