From 1f4bf4d40ec066ecfd9ad71a2147a3843bcf8f6b Mon Sep 17 00:00:00 2001 From: Jan Tulak Date: Thu, 9 Nov 2017 11:35:18 -0600 Subject: [PATCH] metadump: update manpage for dirty log/obfuscation issue This is something that should be documented, as it is not obvious to everyone. Signed-off-by: Jan Tulak [sandeen@redhat.com: edit for clarity] [darrick.wong@oracle.com: edit for more clarity] Reviewed-by: Eric Sandeen Signed-off-by: Eric Sandeen --- man/man8/xfs_metadump.8 | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/man/man8/xfs_metadump.8 b/man/man8/xfs_metadump.8 index 3731d6a36..81748816d 100644 --- a/man/man8/xfs_metadump.8 +++ b/man/man8/xfs_metadump.8 @@ -60,6 +60,22 @@ are not obfuscated. Names between 5 and 8 characters in length inclusively are partially obfuscated. .PP .B xfs_metadump +cannot obfuscate metadata in the filesystem log. Log +recovery of an obfuscated metadump image may expose clear-text +metadata and/or cause filesystem corruption in the restored image. +It is recommended that the source filesystem first be mounted and +unmounted, if possible, to ensure that the log is clean. +A subsequent invocation of +.B xfs_metadump +will capture a clean log and obfuscate all metadata correctly. +.PP +If a metadump must be produced from a filesystem with a dirty log, +it is recommended that obfuscation be turned off with -o option, if +metadata such as filenames is not considered sensitive. If obfuscation +is required on a metadump with a dirty log, please inform the recipient +of the metadump image about this situation. +.PP +.B xfs_metadump should not be used for any purposes other than for debugging and reporting filesystem problems. The most common usage scenario for this tool is when .BR xfs_repair (8) -- 2.47.2