diff mbox series

[3/3] docs(isar-sstate): update documentation of lint command

Message ID 20220719061628.192078-4-adriaan.schmidt@siemens.com
State Superseded, archived
Headers show
Series isar-sstate improvements | expand

Commit Message

Schmidt, Adriaan July 18, 2022, 10:16 p.m. UTC 
Signed-off-by: Adriaan Schmidt <adriaan.schmidt@siemens.com>
---
 scripts/isar-sstate | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/scripts/isar-sstate b/scripts/isar-sstate
index b62aec47..c462a5cb 100755
--- a/scripts/isar-sstate
+++ b/scripts/isar-sstate
@@ -22,7 +22,7 @@  sstate cache:
     `SSTATE_DIR`. To share them, you need to explicitly upload them to
     the shared location, which is what isar-sstate is for.
 
-isar-sstate implements four commands (upload, clean, info, analyze),
+isar-sstate implements five commands (upload, clean, info, analyze, lint),
 and supports three remote backends (filesystem, http/webdav, AWS S3).
 
 ## Commands
@@ -64,8 +64,10 @@  format as `bitbake-diffsigs`.
 
 ### lint
 
-The `lint` command searches form common flaws that reduce the
-cachability of a layer.
+The `lint` command searches for common flaws that reduce the cachability
+of a layer, e.g., signatures containing absolute paths from the host
+environment. Issues found this way usually indicate errors in recipes
+or in Isar itself.
 
 ## Backends