From a408953eebb0dc65441e9ec4becbc8e2dba6c0e8 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Wed, 21 Aug 2019 15:54:35 +0200 Subject: Update sqfsdiff documentation Signed-off-by: David Oberhollenzer --- difftool/options.c | 8 ++++++-- doc/sqfsdiff.1 | 14 ++++++++++---- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/difftool/options.c b/difftool/options.c index c0c1ca6..82b6ddc 100644 --- a/difftool/options.c +++ b/difftool/options.c @@ -29,6 +29,10 @@ static const char *usagestr = "images, this actually parses the filesystems and generates a more\n" "meaningful difference report.\n" "\n" +"The tool can also compare the contents of a squashfs image to a directory.\n" +"This case is detected transparently if --new or --old referes to a directory\n" +"instead of a squashfs image.\n" +"\n" "If only contents are compared, any differences in packed file layout,\n" "ordering, compression, inode allocation and so on is ignored and the two\n" "images are considered equal if each directory contains the same entries,\n" @@ -40,8 +44,8 @@ static const char *usagestr = "\n" "Possible options:\n" "\n" -" --old, -a The first of the two images to compare.\n" -" --new, -b The second of the two images to compare.\n" +" --old, -a The first of the two filesystems to compare.\n" +" --new, -b The second of the two filesystems to compare.\n" "\n" " --no-contents, -C Do not compare file contents.\n" " --no-owner, -O Do not compare file owners.\n" diff --git a/doc/sqfsdiff.1 b/doc/sqfsdiff.1 index c81f05c..381a62b 100644 --- a/doc/sqfsdiff.1 +++ b/doc/sqfsdiff.1 @@ -9,6 +9,10 @@ Compare two squashfs images. In contrast to doing a direct diff of the images, this actually parses the filesystems and generates a more meaningful difference report. .PP +The tool can also compare the contents of a squashfs image to a directory. +This case is detected transparently if \fB\-\-new\fR or \fB\-\-old\fR referes +to a directory instead of a squashfs image. +.PP If only contents are compared, any differences in packed file layout, ordering, compression, inode allocation and so on is ignored and the two images are considered equal if each directory contains the same entries, @@ -21,10 +25,12 @@ that of diff(1): 0 means equal, 1 means different, 2 means problem. Possible options: .TP \fB\-\-old\fR, \fB\-a\fR -Specify the first image, relativ to which the changes are evaluated. +Specify the first filesystem image or source directory, relativ to which the +changes are evaluated. .TP \fB\-\-new\fR, \fB\-b\fR -Specift the second image to compare to the first one. +Specify the second filesystem image to source directory to compare to the +first one. .TP \fB\-\-no\-contents\fR, \fB\-C\fR Do not compare file contents. @@ -47,8 +53,8 @@ Also compare metadata in super blocks. \fB\-\-extract\fR, \fB\-e\fR Extract files that exist in both images but have different contents to the specified directory. Contents of the first image end up in a sub directory -named \fBa\fR and the contents of the second image in a sub directory -named \fBb\fR. +named \fBold\fR and the contents of the second image in a sub directory +named \fBnew\fR. .TP \fB\-\-help\fR, \fB\-h\fR Print help text and exit. -- cgit v1.2.3