[vala/0.40] valadoc: Specify that the "--driver" option is deprecated
- From: Rico Tzschichholz <ricotz src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [vala/0.40] valadoc: Specify that the "--driver" option is deprecated
- Date: Mon, 21 Jan 2019 16:58:20 +0000 (UTC)
commit 360162a04b86522e8c0e82eac05ca8b6d2691ed6
Author: Corentin Noël <corentin elementary io>
Date: Fri Jan 18 12:46:52 2019 +0100
valadoc: Specify that the "--driver" option is deprecated
Fixes https://gitlab.gnome.org/GNOME/vala/issues/736
doc/valadoc.1 | 2 +-
valadoc/valadoc.vala | 25 ++++++++++---------------
2 files changed, 11 insertions(+), 16 deletions(-)
---
diff --git a/doc/valadoc.1 b/doc/valadoc.1
index d703bd581..d0ec2f902 100644
--- 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 11263a0f7..7fb970976 100644
--- 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);
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]