valadoc: Specify that the "--driver" option is deprecated

Fixes https://gitlab.gnome.org/GNOME/vala/issues/736

diff --git a/doc/valadoc.1 b/doc/valadoc.1
index 85970541547b376f84109a493e16db8f022fb46e..c0884e9b9f2d11e186f8f27f7051fa59171b94f0 100644 (file)
--- a/doc/valadoc.1
+++ b/doc/valadoc.1
@@ -48,7 +48,7 @@ Look for package bindings in DIRECTORY
 Include binding for PACKAGE
 .TP
 \fB\-\-driver\fR
-Name of an driver or path to a custom driver
+Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)
 .TP
 \fB\-\-importdir\fR=\fI\,DIRECTORY\/\fR...
 Look for external documentation in DIRECTORY

diff --git a/valadoc/valadoc.vala b/valadoc/valadoc.vala
index 7e74a187b6f8a6208d17bf0f5deb7e8af57eea62..b16500475097b0a190f9879dba844405d1d9cce5 100644 (file)
--- a/valadoc/valadoc.vala
+++ b/valadoc/valadoc.vala
@@ -36,7 +36,6 @@ public class ValaDoc : Object {
        private static string gir_name = null;
        private static string gir_namespace = null;
        private static string gir_version = null;
-       private static string driverpath = null;
 
        private static bool add_inherited = false;
        private static bool _protected = true;
@@ -89,7 +88,7 @@ public class ValaDoc : Object {
                { "vapidir", 0, 0, OptionArg.FILENAME_ARRAY, ref vapi_directories, "Look for package bindings in DIRECTORY", "DIRECTORY..." },
                { "pkg", 0, 0, OptionArg.STRING_ARRAY, ref packages, "Include binding for PACKAGE", "PACKAGE..." },
 
-               { "driver", 0, 0, OptionArg.STRING, ref driverpath, "Name of an driver or path to a custom driver", null },
+               { "driver", 0, OptionFlags.OPTIONAL_ARG, OptionArg.CALLBACK, (void*) option_deprecated, "Name of an driver or path to a custom driver (DEPRECATED AND IGNORED)", null },
 
                { "importdir", 0, 0, OptionArg.FILENAME_ARRAY, ref import_directories, "Look for external documentation in DIRECTORY", "DIRECTORY..." },
                { "import", 0, 0, OptionArg.STRING_ARRAY, ref import_packages, "Include binding for PACKAGE", "PACKAGE..." },
@@ -122,6 +121,11 @@ public class ValaDoc : Object {
                { null }
        };
 
+       static bool option_deprecated (string option_name, string? val, void* data) throws OptionError {
+               stdout.printf ("Command-line option `%s` is deprecated and will be ignored\n", option_name);
+               return true;
+       }
+
        private static int quit (ErrorReporter reporter) {
                if (reporter.errors == 0) {
                        stdout.printf ("Succeeded - %d warning(s)\n", reporter.warnings);
@@ -161,11 +165,10 @@ public class ValaDoc : Object {
                return ValaDoc.pkg_name;
        }
 
-       private ModuleLoader? create_module_loader (ErrorReporter reporter, out Doclet? doclet, out Driver? driver) {
+       private ModuleLoader? create_module_loader (ErrorReporter reporter, out Doclet? doclet) {
                ModuleLoader modules = ModuleLoader.get_instance ();
 
                doclet = null;
-               driver = null;
 
                // doclet:
                string? pluginpath = ModuleLoader.get_doclet_path (docletpath, reporter);
@@ -179,12 +182,6 @@ public class ValaDoc : Object {
                        return null;
                }
 
-
-               // driver:
-               driver = new Valadoc.Drivers.Driver ();
-
-               assert (driver != null && doclet != null);
-
                return modules;
        }
 
@@ -233,20 +230,18 @@ public class ValaDoc : Object {
                settings.alternative_resource_dirs = alternative_resource_dirs;
 
 
+               var driver = new Valadoc.Drivers.Driver ();
+
                // load plugins:
                Doclet? doclet = null;
-               Driver? driver = null;
-
-               ModuleLoader? modules = create_module_loader (reporter, out doclet, out driver);
+               ModuleLoader? modules = create_module_loader (reporter, out doclet);
                if (reporter.errors > 0 || modules == null) {
                        return quit (reporter);
                }
 
-
                // Create tree:
                Valadoc.Api.Tree doctree = driver.build (settings, reporter);
                if (reporter.errors > 0) {
-                       driver = null;
                        doclet = null;
                        return quit (reporter);
                }