mkfs: Add a note for people changing input options

Commit Message

Jan Tulak April 6, 2017, 2:55 p.m. UTC

A simple reminder to update test xfs/191-input-validation
if input behaviour is changed (e.g. new option added).

Signed-off-by: Jan Tulak <[e-mail]>
---
 mkfs/xfs_mkfs.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Patch

diff --git a/mkfs/xfs_mkfs.c b/mkfs/xfs_mkfs.c
index 5aac4d1b..7a5c49fc 100644
--- a/mkfs/xfs_mkfs.c
+++ b/mkfs/xfs_mkfs.c
@@ -50,6 +50,14 @@  unsigned int		sectorsize;
 /*
  * Table for parsing mkfs parameters.
  *
+ * !!! NOTE ==================================================================
+ *
+ * If you are adding a new option, or changing an existing one,
+ * please, update also xfstests - test xfs/191-input-validation
+ * with expected behaviour (simple fail/pass).
+ *
+ * !!! END OF NOTE ===========================================================
+ *
  * Description of the structure members follows:
  *
  * name MANDATORY
@@ -110,6 +118,14 @@  unsigned int		sectorsize;
  *     sets what is used with simple specifying the subopt (-d file).
  *     A special SUBOPT_NEEDS_VAL can be used to require a user-given
  *     value in any case.
+ *
+ * !!! NOTE ==================================================================
+ *
+ * If you are adding a new option, or changing an existing one,
+ * please, update also xfstests - test xfs/191-input-validation
+ * with expected behaviour (simple fail/pass).
+ *
+ * !!! END OF NOTE ===========================================================
  */
 struct opt_params {
 	const char	name;