write_common: Remove check which is never true.

[paraslash.git] / write.h

diff --git a/write.h b/write.h
index c7196dc5644614e66525b1bfa524ec346579d64d..fd0f4f6ba7b42b186eab05efbc5ee61cdf499140 100644 (file)
--- a/write.h
+++ b/write.h
@@ -36,13 +36,20 @@ struct writer {
        /**
         * The command line parser of the writer.
         *
-        * It should check whether the command line options given by \a options are
-        * valid.  On success, it should return a pointer to the writer-specific
-        * configuration data determined by \a options.  Note that this might be called
-        * more than once with different values of \a options.
+        * It should check whether the command line options given by \a options
+        * are valid and return a pointer to the writer-specific configuration
+        * data determined by \a options. This function must either succeed or
+        * call exit(). Note that parse_config_or_die() might be called more
+        * than once with different values of \a options. \sa \ref
+        * free_config().
         */
-       void *(*parse_config)(const char *options);
-       void (*free_config)(void *conf);
+       void *(*parse_config_or_die)(const char *options);
+       /**
+        * Dellocate all configuration resources.
+        *
+        * This should free whatever was allocated by \ref parse_config_or_die().
+        */
+       void (*free_config)(void *config);
        /**
         * Open one instance of this writer.
         *