[PATCH] vdr-2.1.10: CLI Help ---> argsdir Templates (/etc/vdr/conf.d/*.conf.tmpl oder /tmp/*.conf.tmpl)

Nachdem ich den Thread durchgelesen habe bin ich nun der Meinung, dass es nichtmal ein Standalone-Tool für den Zweck braucht.

Es macht keinen Sinn automatisch die Hilfetexte in Templates zu schreiben. Zum einen ist das Aufgabe des Distributors (Beispiel: vdr4arch wo es bereits für jedes Plugin ein vorbereitetes Template gibt) zum anderen werden diese zu einem Zeitpunkt X (hoffentlich) von den Plugin-Autoren vorbereitet und mit dem Plugin ausgeliefert.

Ob man es braucht oder nicht, spielt doch keine Rolle. Solange jemand Spass daran, solch ein Tool zu basteln, hat es auch seine Berechtigung. Nur den VDR unnötig patchen, muss nicht sein.

Für Selbstbauer, wie mich, kann so ein Tool nützlich sein, denn ich hab meine conf-Dateien noch per Hand erstellt. Hilfetexte find ich in den Templates auch nicht schlecht. Dann muss man nicht erst wegen Pluginoption XY die README oder vdr --help bemühen.

So war das auch nicht gemeint.

Natürlich darf jeder das programmieren, was ihm Spaß macht.

Als Übergangslösung mag das für den einen oder anderen auch ganz praktisch sein.

Es wäre aber schade wenn das Vorhandensein einer solchen Funktion in der Zukunft von Plugin-Autoren als Grund genommen würde, keine eigenen Templates mitzuliefern.

Zitat von M-Reimer

Es wäre aber schade wenn das Vorhandensein einer solchen Funktion in der Zukunft von Plugin-Autoren als Grund genommen würde, keine eigenen Templates mitzuliefern.

Ja das hast Du recht, aber bis es soweit ist, fliesst noch viel Wasser dem Rhein hinab.

Wie wäre es mit einem ersten Schritt in eine gemeinsame Richtung, indem wir den vdr patchen, dass er bei "vdr -Pplugin --help" nur die Hilfe des Plugins, aber nicht die vdr-Hilfe ausgibt?
Denn die will man bei so einem Aufruf doch höchst wahrscheinlich nicht sehen, oder?

Lars.

vdr-Hilfe und die Hilfe aller Plugins anzeigen (wie bisher):

vdr --help

vdr-Hilfe und die Hilfe der angegebenen Plugins anzeigen (wie bisher):

vdr --help -Pplugin1 -Pplugin2 ...

Nur die Hilfe der angegebenen Plugins anzeigen:

vdr -Pplugin1 -Pplugin2 ... --help

diff --git a/vdr.c b/vdr.c
index 71a72f2..c6c4644 100644
--- a/vdr.c
+++ b/vdr.c
@@ -211,6 +211,8 @@ int main(int argc, char *argv[])
   const char *EpgDataFileName = DEFAULTEPGDATAFILENAME;
   bool DisplayHelp = false;
   bool DisplayVersion = false;
+  bool DisplayOnlyPluginHelp = false;
+  bool HaveSeenPluginParameter = false;
   bool DaemonMode = false;
   int SysLogTarget = LOG_USER;
   bool MuteAudio = false;
@@ -374,6 +376,8 @@ int main(int argc, char *argv[])
           case 'g': cSVDRP::SetGrabImageDir(*optarg != '-' ? optarg : NULL);
                     break;
           case 'h': DisplayHelp = true;
+                    if (HaveSeenPluginParameter)
+                       DisplayOnlyPluginHelp = true;
                     break;
           case 'i': if (isnumber(optarg)) {
                        InstanceId = atoi(optarg);
@@ -438,6 +442,7 @@ int main(int argc, char *argv[])
                        }
                     break;
           case 'P': PluginManager.AddPlugin(optarg);
+                    HaveSeenPluginParameter = true;
                     break;
           case 'r': cRecordingUserCommand::SetCommand(optarg);
                     break;
@@ -523,7 +528,7 @@ int main(int argc, char *argv[])
      if (!PluginManager.HasPlugins())
         PluginManager.AddPlugin("*"); // adds all available plugins
      PluginManager.LoadPlugins();
-     if (DisplayHelp) {
+     if (DisplayHelp && !DisplayOnlyPluginHelp) {
         printf("Usage: vdr [OPTIONS]\n\n"          // for easier orientation, this is column 80|
                "  -a CMD,   --audio=CMD    send Dolby Digital audio to stdin of command CMD\n"
                "            --cachedir=DIR save cache files in DIR (default: %s)\n"

Lars.

Zitat von mini73

indem wir den vdr patchen, dass er bei "vdr -Pplugin --help" nur die Hilfe des Plugins, aber nicht die vdr-Hilfe ausgibt?

Es wurde vielleicht noch nicht deutlich genug gesagt.

mini73, wir wollen den VDR gar nicht patchen.

Ich weiß, aber sonst kommt man nicht bequem an die Hilfe eines Plugins.

Lars

Vielleicht nimmt kls ja die Anregung mit in den VDR. Hast ja schon die Anregung gemacht.

Fragen kostet ja nichts... Außer ein bisschen Mut.

Lars

Ich habe ihn gestern schon wegen etwas Ähnlichem angeschrieben. Um mal vorzufühlen

Ich sehe gerade, dass ich Antwort habe.

Klaus lehnt es ab den VDR wegen den Templates zu patchen.

Plugins wegen der Menüsortierung anders zu priorisieren hält er für wenig sinnvoll. Es wird in irgendeiner zukünftigen Version "benutzerdefinierte Menügestaltung" geben. Einziger Grund für eine spezielle Ladereihenfolge sieht er bei Plugins, die erst etwas tun können, nachdem ein anderes geladen wurde.

Und zu vdrctl sagt er mehr oder weniger nur, dass er nichts übernimmt wenn sich nicht alle auf exakt ein Tool geeinigt haben. Wenn es mehrere Tools gibt bevorzugt er das Kleinere. Er hält Perl für die richtige Sprache für ein solches Tool.

Ich hoffe ich habe das so richtig wiedergegeben. Der Rest der Mail ist interessant, aber hierzu weniger relevant

Copperhead: du hattest gefragt, ob ich ein vdrctl Tool mit in die VDR-Source aufnehmen würde. Dem stehe ich negativ gegenüber, weil ich mir damit nur was ans Bein binden würde, was sich vermultich dauernd ändert und jeder anders haben will - und die Distris dann letztlich doch ein eigenes Süppchen kochen. Daß ich es ablehne "VDR wegen den Templates zu patchen" habe ich nicht gesagt. Wenn es gute Gründe gibt, z.B. die Ausgabe der Kommandozeilen-Hilfe zu ändern, dann bin ich da durchaus offen.

Klaus

Wow. OK. Ich hatte den Post von mini73 (#46) als Ergänzung zum bereits geposteten Patch wahrgenommen und habe deine Aussage daher darauf übertragen. Das der Patch eigenständig ist, war mir bis jetzt nicht bewusst.

Zitat von kls

du hattest gefragt, ob ich ein vdrctl Tool mit in die VDR-Source aufnehmen würde. Dem stehe ich negativ gegenüber, weil ich mir damit nur was ans Bein binden würde, was sich vermultich dauernd ändert und jeder anders haben will - und die Distris dann letztlich doch ein eigenes Süppchen kochen.

Deswegen ja die Aussage von mir, dass sich alle einig sein müssen. Damit es sich eben nicht ständig ändert.

Ein Grund für vdrctl soll ja die Distributionsübergreifende Einheitlichkeit in der Bedienung des VDR sein, bzw. ein standardisierter Unterbau für die ganzen config-Dateien und deren Lage im Dateisystem. Das passt eventuell den Distris nicht, da die Kundenbindung nicht mehr so groß sein wird, da ein Tool übergreifend das gleiche macht und die configs immer an der gleichen Stelle liegen. Da muss sich der User nicht umgewöhnen und kann problemlos die Distri wechseln, aber das ist ja nicht gewollt. Wenn die Distris nicht mitziehen wollen, gibt es doch unabhängige Repos oder Overlays, die von uns maintained werden können.

Ich bin mir sicher, dass es sich auf EIN vdrctl geeinigt wird, dann kann Klaus sich an die Integration machen.

Ich würde gerne den Vergleich zu Git nochmal herstellen.

Dort werden Infos unten angefügt, allerdings nur temporär. In der Zeildatei landet das nicht.
So dumm finde ich das gar nicht. Dann müsste man keine Templates ablegen und hätte immer die aktuellen Infos.
Ich könnte sowas für vdrctl umsetzen. Die Komplexität steigt natürlich, alles in allem sollte das aber einfach umzusetzen sein.

Jetzt wo ich verstanden habe, was mini73 mit seinem Patch aus Post 46 vorhat, sehe ich das als beste und schnellste Lösung. Alles unter der Voraussetzung, dass ich Klaus diesmal richtig verstanden habe und er einen solchen Patch akzeptiert.