From e6e3de02661076d5b11a270c357e9eced9efe78a Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sun, 12 Oct 2014 19:23:59 -0400 Subject: add --- doc/todo/vicfg_comment_gotcha.mdwn | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/todo/vicfg_comment_gotcha.mdwn diff --git a/doc/todo/vicfg_comment_gotcha.mdwn b/doc/todo/vicfg_comment_gotcha.mdwn new file mode 100644 index 000000000..33befd383 --- /dev/null +++ b/doc/todo/vicfg_comment_gotcha.mdwn @@ -0,0 +1,16 @@ +A user might run vicfg and want to reset a line back to the default value +from the value they have periously set. A natural way to do that is to +comment out the line (or delete it). However, what that actually does is +vicfg parses the result and skips over that setting, since it's not +present, and so no change is saved. + +It could try to parse commented out lines and detect deleted lines, +but that way lies madness. Also, it's not at all clear what the "default" +should be in response to such an action. The default varies per type of +configuration, and vicfg does't know about defaults. + +Instead, I think it should detect when a setting provided in the input +version of the file is not present in the output version, and plop the user +back into the editor with an error, telling them that cannot be handled, +and suggesting they instead change the value to the value they now want it +to have. -- cgit v1.2.3