sa_impl: fix SA header bitfield docs

robn · tonyhutter · commit c25d5140b0a5 · 2024-11-05T15:43:52.000-08:00
Off by one, confused me a while! Sponsored-by: Klara, Inc. Sponsored-by: Wasabi Technology, Inc. Reviewed by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Alexander Motin <mav@FreeBSD.org> Reviewed-by: Tino Reichardt <milky-zfs@mcmilk.de> Signed-off-by: Rob Norris <rob.norris@klarasystems.com> Closes openzfs#16500
diff --git a/include/sys/sa_impl.h b/include/sys/sa_impl.h
@@ -167,8 +167,8 @@ typedef struct sa_hdr_phys {
 	 * | hdrsz  |layout |
 	 * +--------+-------+
 	 *
-	 * Bits 0-10 are the layout number
-	 * Bits 11-16 are the size of the header.
+	 * Bits 0-9 (10 bits) are the layout number (0-1023)
+	 * Bits 10-15 (6 bits) are the size of the header (0-63)
 	 * The hdrsize is the number * 8
 	 *
 	 * For example.

Original file line number	Diff line number	Diff line change
`@@ -167,8 +167,8 @@ typedef struct sa_hdr_phys {`
`167`	`167`	`* \| hdrsz \|layout \|`
`168`	`168`	`* +--------+-------+`
`169`	`169`	`*`
`170`		`- * Bits 0-10 are the layout number`
`171`		`- * Bits 11-16 are the size of the header.`
	`170`	`+ * Bits 0-9 (10 bits) are the layout number (0-1023)`
	`171`	`+ * Bits 10-15 (6 bits) are the size of the header (0-63)`
`172`	`172`	`* The hdrsize is the number * 8`
`173`	`173`	`*`
`174`	`174`	`* For example.`