From c0a8430d20337684e276d0d22d344782c50e2054 Mon Sep 17 00:00:00 2001 From: Johannes Schauer Marin Rodrigues Date: Tue, 30 Jul 2024 13:46:51 +0200 Subject: [PATCH] docs/man1/bmaptool.1: fix incorrect description of bmap and signature file discovery For example, if the image file is called foo.img.gz, then bmaptool will look for bmap files in this order: foo.img.gz.bmap foo.img.bmap foo.bmap Closes: #30 --- docs/man1/bmaptool.1 | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/man1/bmaptool.1 b/docs/man1/bmaptool.1 index 6f1dd3a..5093b48 100644 --- a/docs/man1/bmaptool.1 +++ b/docs/man1/bmaptool.1 @@ -77,8 +77,12 @@ be a regular file or a block device (only local). .PP Unless the bmap file is explicitly specified with the "--bmap" option, \fIbmaptool\fR -automatically discovers it by looking for a file with the same basename as IMAGE -but with the ".bmap" extension. The bmap file is only looked for in +automatically discovers it by looking for a file with the same name as IMAGE +but with the ".bmap" extension. If it was unable to find it that way, it will +try filenames with each extension of IMAGE removed and ".bmap" added to it. So +if your IMAGE is named \fIdisk.img.gz\fR, it will first try +\fIdisk.img.gz.bmap\fR, then \fIdisk.img.bmap\fR and finally \fIdisk.bmap\fR. +The bmap file is only looked for in IMAGE's directory (or base URL, in case IMAGE was specified as an URL). If the bmap file is not found, \fIbmaptool\fR fails. To copy without bmap, use the "--nobmap" option. @@ -149,7 +153,9 @@ signature). .PP The detached signature can be specified with the "--bmap-sig" option, otherwise \fIbmaptool\fR tries to automatically discover it by looking for a file with -the same basename as the bmap file but with the ".asc" or ".sig" extension. +the same name as the bmap file but with the ".asc" or ".sig" extension. +If it was unable to find it that way, it will try filenames with each extension +of IMAGE removed and ".asc" or ".sig" added to it. This is very similar to the bmap file auto-discovery. So if a ".asc" or ".sig" file exists, \fIbmaptool\fR will verify the signature.