Skip to contentSkip to conversation

sensord: Remove commandline interface.

PATCH In review Andre Prendel 2 participants 4 messages Apr 6, 2009 – Apr 21, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/8 sensord: Remove commandline interface.

Remove the hidden commandline interface of sensord.

Sensord can be invoked as an console application. Therefor a link named sensors pointing to sensord is needed. That is very intransparent and IMO useless. Printing sensor values to console is done by the sensors tool.
---

 args.c |   38 +++++++++-----------------------------
 1 file changed, 9 insertions(+), 29 deletions(-)
prog/sensord/args.c +9 -28
@@ -127,19 +127,6 @@
 	"the RRD file configuration must EXACTLY match the sensors that are used. If\n"
 	"your configuration changes, delete the old RRD file and restart sensord.\n";
 
-static const char *appSyntax -	"  -a, --alarm-scan          -- only scan for alarms\n"
-	"  -s, --set                 -- execute set statements (root only)\n"
-	"  -r, --rrd-file <file>     -- only update RRD file\n"
-	"  -c, --config-file <file>  -- configuration file\n"
-	"  -d, --debug               -- display some debug information\n"
-	"  -v, --version             -- display version and exit\n"
-	"  -h, --help                -- display help and exit\n"
-	"\n"
-	"Specify the filename `-' to read the config file from stdin.\n"
-	"\n"
-	"If no chips are specified, all chip info will be printed.\n";
-
 static const char *daemonShortOptions = "i:l:t:Tf:r:c:p:advhg:";
 
 static const struct option daemonLongOptions[] = {
@@ -159,19 +146,6 @@
 	{ NULL, 0, NULL, 0 }
 };
 
-static const char *appShortOptions = "asr:c:dvh";
-
-static const struct option appLongOptions[] = {
-	{ "alarm-scan", no_argument, NULL, 'a' },
-	{ "set", no_argument, NULL, 's' },
-	{ "rrd-file", required_argument, NULL, 'r' },
-	{ "config-file", required_argument, NULL, 'c' },
-	{ "debug", no_argument, NULL, 'd' },
-	{ "version", no_argument, NULL, 'v' },
-	{ "help", no_argument, NULL, 'h' },
-	{ NULL, 0, NULL, 0 }
-};
-
 int parseArgs(int argc, char **argv)
 {
 	int c;
@@ -179,8 +153,14 @@
 	const struct option *longOptions;
 
 	isDaemon = (argv[0][strlen (argv[0]) - 1] = 'd');
-	shortOptions = isDaemon ? daemonShortOptions : appShortOptions;
-	longOptions = isDaemon ? daemonLongOptions : appLongOptions;
+	if (!isDaemon) {
+		fprintf(stderr, "Sensord no longer runs as an commandline"
+			" application.\n");
+		return -1;
+	}
+
+	shortOptions = daemonShortOptions;
+	longOptions = daemonLongOptions;
 
 	while ((c = getopt_long(argc, argv, shortOptions, longOptions, NULL))
 	       != EOF) {
@@ -235,7 +215,7 @@
 			break;
 		case 'h':
 			printf("Syntax: %s {options} {chips}\n%s", argv[0],
-			       isDaemon ? daemonSyntax : appSyntax);
+			       daemonSyntax);
 			exit(EXIT_SUCCESS);
 			break;
 		case ':':

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors

#1 lore raw
Quoted 6 lines · Andre Prendel

Remove the hidden commandline interface of sensord.

Sensord can be invoked as an console application. Therefor a link named sensors pointing to sensord is needed. That is very intransparent and IMO useless. Printing sensor values to console is done by the sensors tool.

I agree. I guess the original idea was that "sensord" would possibly ultimately supersede "sensors" but that did not happen and I don't think this will ever happen due to the extra dependencies sensord requires (librrd).

Quoted 50 lines

---

 args.c |   38 +++++++++-----------------------------
 1 file changed, 9 insertions(+), 29 deletions(-)
prog/sensord/args.c +0 -25
@@ -127,19 +127,6 @@
 	"the RRD file configuration must EXACTLY match the sensors that are used. If\n"
 	"your configuration changes, delete the old RRD file and restart sensord.\n";
 
-static const char *appSyntax > -	"  -a, --alarm-scan          -- only scan for alarms\n"
-	"  -s, --set                 -- execute set statements (root only)\n"
-	"  -r, --rrd-file <file>     -- only update RRD file\n"
-	"  -c, --config-file <file>  -- configuration file\n"
-	"  -d, --debug               -- display some debug information\n"
-	"  -v, --version             -- display version and exit\n"
-	"  -h, --help                -- display help and exit\n"
-	"\n"
-	"Specify the filename `-' to read the config file from stdin.\n"
-	"\n"
-	"If no chips are specified, all chip info will be printed.\n";
-
 static const char *daemonShortOptions = "i:l:t:Tf:r:c:p:advhg:";
 
 static const struct option daemonLongOptions[] = {
@@ -159,19 +146,6 @@
 	{ NULL, 0, NULL, 0 }
 };
 
-static const char *appShortOptions = "asr:c:dvh";
-
-static const struct option appLongOptions[] = {
-	{ "alarm-scan", no_argument, NULL, 'a' },
-	{ "set", no_argument, NULL, 's' },
-	{ "rrd-file", required_argument, NULL, 'r' },
-	{ "config-file", required_argument, NULL, 'c' },
-	{ "debug", no_argument, NULL, 'd' },
-	{ "version", no_argument, NULL, 'v' },
-	{ "help", no_argument, NULL, 'h' },
-	{ NULL, 0, NULL, 0 }
-};
-
 int parseArgs(int argc, char **argv)
 {
 	int c;
@@ -179,8 +153,14 @@
 	const struct option *longOptions;
 
 	isDaemon = (argv[0][strlen (argv[0]) - 1] = 'd');

prog/sensord/args.c line 163

Quoted 10 lines
prog/sensord/args.c +8 -2
-	shortOptions = isDaemon ? daemonShortOptions : appShortOptions;
-	longOptions = isDaemon ? daemonLongOptions : appLongOptions;
+	if (!isDaemon) {
+		fprintf(stderr, "Sensord no longer runs as an commandline"
+			" application.\n");
+		return -1;
+	}
+
+	shortOptions = daemonShortOptions;
+	longOptions = daemonLongOptions;

I presume we could go one step further and rename daemonShortOptions and daemonLongOptions to shortOptions and longOptions, respectively? Or, alternatively, use daemonShortOptions and daemonLongOptions in the code below.

prog/sensord/args.c line 221

Quoted 12 lines
prog/sensord/args.c +1 -1
 	while ((c = getopt_long(argc, argv, shortOptions, longOptions, NULL))
 	       != EOF) {
@@ -235,7 +215,7 @@
 			break;
 		case 'h':
 			printf("Syntax: %s {options} {chips}\n%s", argv[0],
-			       isDaemon ? daemonSyntax : appSyntax);
+			       daemonSyntax);
 			exit(EXIT_SUCCESS);
 			break;
 		case ':':

There are many other references to isDaemon left in the code, which suggests that there is room for many additional cleanups. Are you going to do this?

Thanks,

Signature · 6 lines
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
#2 lore raw
In reply to Andre Prendel
Quoted 62 lines · Jean Delvare
Quoted 6 lines · Andre Prendel

Remove the hidden commandline interface of sensord.

Sensord can be invoked as an console application. Therefor a link named sensors pointing to sensord is needed. That is very intransparent and IMO useless. Printing sensor values to console is done by the sensors tool.

I agree. I guess the original idea was that "sensord" would possibly ultimately supersede "sensors" but that did not happen and I don't think this will ever happen due to the extra dependencies sensord requires (librrd).

Quoted 49 lines

---

 args.c |   38 +++++++++-----------------------------
 1 file changed, 9 insertions(+), 29 deletions(-)
prog/sensord/args.c +0 -25
@@ -127,19 +127,6 @@
 	"the RRD file configuration must EXACTLY match the sensors that are used. If\n"
 	"your configuration changes, delete the old RRD file and restart sensord.\n";
 
-static const char *appSyntax > > -	"  -a, --alarm-scan          -- only scan for alarms\n"
-	"  -s, --set                 -- execute set statements (root only)\n"
-	"  -r, --rrd-file <file>     -- only update RRD file\n"
-	"  -c, --config-file <file>  -- configuration file\n"
-	"  -d, --debug               -- display some debug information\n"
-	"  -v, --version             -- display version and exit\n"
-	"  -h, --help                -- display help and exit\n"
-	"\n"
-	"Specify the filename `-' to read the config file from stdin.\n"
-	"\n"
-	"If no chips are specified, all chip info will be printed.\n";
-
 static const char *daemonShortOptions = "i:l:t:Tf:r:c:p:advhg:";
 
 static const struct option daemonLongOptions[] = {
@@ -159,19 +146,6 @@
 	{ NULL, 0, NULL, 0 }
 };
 
-static const char *appShortOptions = "asr:c:dvh";
-
-static const struct option appLongOptions[] = {
-	{ "alarm-scan", no_argument, NULL, 'a' },
-	{ "set", no_argument, NULL, 's' },
-	{ "rrd-file", required_argument, NULL, 'r' },
-	{ "config-file", required_argument, NULL, 'c' },
-	{ "debug", no_argument, NULL, 'd' },
-	{ "version", no_argument, NULL, 'v' },
-	{ "help", no_argument, NULL, 'h' },
-	{ NULL, 0, NULL, 0 }
-};
-
 int parseArgs(int argc, char **argv)
 {
 	int c;
@@ -179,8 +153,14 @@
 	const struct option *longOptions;
 
Quoted 16 lines

prog/sensord/args.c line 163

Quoted 11 lines
prog/sensord/args.c +8 -2
 	isDaemon = (argv[0][strlen (argv[0]) - 1] = 'd');
-	shortOptions = isDaemon ? daemonShortOptions : appShortOptions;
-	longOptions = isDaemon ? daemonLongOptions : appLongOptions;
+	if (!isDaemon) {
+		fprintf(stderr, "Sensord no longer runs as an commandline"
+			" application.\n");
+		return -1;
+	}
+
+	shortOptions = daemonShortOptions;
+	longOptions = daemonLongOptions;

I presume we could go one step further and rename daemonShortOptions and daemonLongOptions to shortOptions and longOptions, respectively? Or, alternatively, use daemonShortOptions and daemonLongOptions in the code below.

That's right. I will send you an updated patch series.

Quoted 17 lines

prog/sensord/args.c line 221

Quoted 13 lines
prog/sensord/args.c +1 -1
 	while ((c = getopt_long(argc, argv, shortOptions, longOptions, NULL))
 	       != EOF) {
@@ -235,7 +215,7 @@
 			break;
 		case 'h':
 			printf("Syntax: %s {options} {chips}\n%s", argv[0],
-			       isDaemon ? daemonSyntax : appSyntax);
+			       daemonSyntax);
 			exit(EXIT_SUCCESS);
 			break;
 		case ':':

There are many other references to isDaemon left in the code, which suggests that there is room for many additional cleanups. Are you going to do this?

Will fix this in v2 too. What about the two occurrences at the beginning of parseArgs? I would prefer leaving that to inform the user about the change of the behaviour.

Andre

Quoted 3 lines

Thanks,

Signature · 1 line
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors

#3 lore raw
In reply to Andre Prendel
Quoted 8 lines · Andre Prendel
Quoted 3 lines · Jean Delvare

There are many other references to isDaemon left in the code, which suggests that there is room for many additional cleanups. Are you going to do this?

Will fix this in v2 too. What about the two occurrences at the beginning of parseArgs? I would prefer leaving that to inform the user about the change of the behaviour.

Yes, this is fine with me. We can remove them later, in a year or two.

Signature · 6 lines
Jean Delvare

_______________________________________________
lm-sensors mailing list
[email protected]
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors