xfs/040: document purpose

Getting xfs/040 to "pass" takes a bit of effort, however the effort
to require updating xfsprogs is purely an xfsprogs maintainer task
only. There no functional gain by users of xfs or a QA team to get
this test to pass. This is not trivial from the current description
so document this.

Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org>
Reviewed-by: Bill O'Donnell <billodo@redhat.com>
Signed-off-by: Eryu Guan <eguan@redhat.com>

diff --git a/tests/xfs/040 b/tests/xfs/040
index fadb888cbfaf274faf9564c81511af6bb92c3e60..3fd31899244efb504e7e2caf14a514ab09c430ba 100755 (executable)
--- a/tests/xfs/040
+++ b/tests/xfs/040
@@ -3,6 +3,11 @@
 #
 # compare-libxfs test
 #
+# The purpose of this test is only to nag the maintainer of xfsprogs to try to
+# keep xfsprogs's libxfs files in sync with the latest kernel's libxfs. There
+# is no functional need for anyone to actually run this test to confirm
+# proper XFS functionalilty, this is an xfsprogs maintainer test.
+#
 #-----------------------------------------------------------------------
 # Copyright (c) 2000-2001 Silicon Graphics, Inc.  All Rights Reserved.
 #