commandref-build

Begonnen von UliM, 25 Juni 2013, 09:02:34

Vorheriges Thema - Nächstes Thema

UliM

Hallo,
nach update erscheinen die Module 95_remotecontrol.pm (und speedtest - da ist aber das .pm noch nicht im SVN) in der commandref zwar in der Liste der Helper-Module, jedoch ist der pod-Text nicht eingefügt.
Klemmt da ein job oder muss man etwas tun, um diese Texte einzubinden?
Gruß, Uli
RPi4/Raspbian, CUL V3 (ca. 30 HomeMatic-devices), LAN (HarmonyHub, alexa etc.).  Fördermitglied des FHEM e.V.

justme1968

speedtest hab ich eben repariert. ich hatte es mit dem falschen pfad eingecheckt.

gruss
  andre
hue, tradfri, alexa-fhem, homebridge-fhem, LightScene, readingsGroup, ...

https://github.com/sponsors/justme-1968

rudolfkoenig

Repariert wuerde ich noch nicht sagen:

% perl contrib/commandref_join.pl
EN FHEM/10_CUL_IR.pm: Unbalanced li (3, last line ok: 399)
EN FHEM/10_EIB.pm: Unbalanced li (5, last line ok: 607)
EN FHEM/95_FLOORPLAN.pm: Unbalanced li (1, last line ok: 808)
EN FHEM/20_FRM_IN.pm: Unbalanced li (1, last line ok: 158)
EN FHEM/00_HMLAN.pm: Unbalanced li (6, last line ok: 587)
EN FHEM/10_IT.pm: Unbalanced li (4, last line ok: 478)
EN FHEM/95_PachLog.pm: Unbalanced li (1, last line ok: 292)
EN SVG: No document text found
EN Utils: No document text found
EN WEBTHERM: No document text found
EN remotecontrol: No document text found
EN FHEM/32_speedtest.pm: Unbalanced li (3, last line ok: 177)
DE FHEM/95_FLOORPLAN.pm: Unbalanced li (2, last line ok: 956)


Ich drohe hiermit dem WEBTHERM Modul mit Entzug der "FHEM" Lizenz (da kein Doku).
98_SVG.pm ist kein eigenstaendiges Modul (ich zoegere es nur nach SVG.pm umzubenennen), und Utils.pm zaehlt nicht.

Waere nett, wenn der Rest vom jeweiligen Modulautor gefixed wird.
Sehe gerade, dass ich PachLog geerbt habe, und mich selbst an der Nase fassen darf...

rudolfkoenig

Nachtrag: remotecontrol doku wird nicht erkannt, da FHEM/95_remotecontrol.pm mit DOS CR/NL eingecheckt ist.

justme1968

den pfad repariert...

die doku warnungen sind jetzt auch weg. zumindest meine.
hue, tradfri, alexa-fhem, homebridge-fhem, LightScene, readingsGroup, ...

https://github.com/sponsors/justme-1968

UliM

Zitat von: rudolfkoenig schrieb am Di, 25 Juni 2013 10:00Nachtrag: remotecontrol doku wird nicht erkannt, da FHEM/95_remotecontrol.pm mit DOS CR/NL eingecheckt ist.
Hi,
ups, behoben + eingecheckt.
=8-)
RPi4/Raspbian, CUL V3 (ca. 30 HomeMatic-devices), LAN (HarmonyHub, alexa etc.).  Fördermitglied des FHEM e.V.

betateilchen

Da mich die Fehlermeldungen beim commandref_join immer irritiert haben, konnte ich nicht umhin, mich mal hinzusetzen...

Vielleicht könnten sich die jeweiligen modulverantwortlichen Entwicklerkollegen bei Gelegenheit der Sache annehmen und die Patches einbauen. Dann klappts auch mit dem commandref. Die komplett fehlenden Dokus habe ich aber nicht auch noch erstellt *lach*

Viele Grüße
Udo
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig


betateilchen

Hallo Rudi,

gern geschehen :)

Aktuell bekomme ich jetzt nur noch drei Meldungen:


*** EN FHEM/98_SVG.pm: No document text found
*** EN FHEM/99_Utils.pm: No document text found
*** EN FHEM/23_WEBTHERM.pm: No document text found


könnte man da nicht zumindest jeweils eine leere Dummy-Doku einbauen, damit das Meckern aufhört?
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Markus Bloch

Zitat von: betateilchen schrieb am Di, 30 Juli 2013 12:30könnte man da nicht zumindest jeweils eine leere Dummy-Doku einbauen, damit das Meckern aufhört?

Für WEBTHERM: Damit behandelst du aber nur das Symptom und nicht die Ursache ;-) Die Doku währe dennoch nicht vorhanden. Und ein Modul ohne Doku ist aus meiner Sicht kein hilfreiches Modul.

Für SVG und Utils währe das denke ich eine Lösung.
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

betateilchen

Zitat von: Markus Bloch schrieb am Di, 30 Juli 2013 13:54Für [...] Utils wäre das denke ich eine Lösung.

Wenns weiter nix ist... bitteschön :)


=pod
=begin html

<a name="Utils"></a>
<h3>Utils</h3>
<ul>
<br/>
This is a collection of functions that can be used module-independant in all your own development<br/>
</br>
<pre>
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
# IMPORTANT: do not insert your own functions inside
# the file 99_Utils.pm!
#
# This file will be overwritten during an FHEM update and all
# your own inserts will be lost.
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
#
# To avoid this, we recommend following procedure:
#
# 1. Create your own file 99_myUtils.pm from the template below
# 2. Put this file inside the ./FHEM directory
# 3. Put your own functions into this new file
#
<br/>
<code>
# start-of-template
package main;

use strict;
use warnings;
use POSIX;

sub
myUtils_Initialize($$)
{
my ($hash) = @_;
}

# start with your own functions below this line


# behind your last function, we need the following
1;
# end-of-template
</code>
</pre>
</br>
<b>Defined functions</b><br/><br/>
<ul>
<li><b>abstime2rel()</b><br>???</li><br/>
<li><b>ltrim()</b><br>returns string without leading spaces</li><br/>
<li><b>max()</b><br>returns the highest value from a given list (sorted alphanumeric)</li><br/>
<li><b>maxNum()</b><br>returns the highest value from a given list (sorted numeric)</li><br/>
<li><b>min()</b><br>returns the lowest value from a given list (sorted alphanumeric)</li><br/>
<li><b>minNum()</b><br>returns the lowest value from a given list (sorted numeric)</li><br/>
<li><b>rtrim()</b><br>returns string without trailing spaces</li><br/>
<li><b>time_str2num()</b><br>???</li><br/>
<li><b>trim()</b><br>returns string without leading and without trailing spaces</li><br/>
<li><b>UntoggleDirect()</b><br>For devices paired directly, converts state 'toggle' into 'on' or 'off'</li><br/>
<li><b>UntoggleIndirect()</b><br>For devices paired indirectly, switches the target device 'on' or 'off' <br/>
also when a 'toggle' was sent from the source device</li><br/>
</ul>
</ul>
=end html
=cut


Kann bitte noch jemand die beiden Zeit-Konvertierungen beschreiben?
Und in der Funktion "UntoggleIndirect" ist noch ein Fehler, dort wird ein Logeintrag mit "UntoggleDirect" geschrieben.
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

betateilchen

Zitat von: Markus Bloch schrieb am Di, 30 Juli 2013 13:54Für WEBTHERM: Damit behandelst du aber nur das Symptom und nicht die Ursache ;-) Die Doku währe dennoch nicht vorhanden. Und ein Modul ohne Doku ist aus meiner Sicht kein hilfreiches Modul.

Naja, was dieses Modul macht (bzw. machen soll) ist ja kein großes Geheimnis. ABER: in der Version, in der es derzeit eingecheckt ist, kann es aufgrund eines eingebauten Fehlers sowieso nicht funktionieren.

Wäre es so genehm?

(http://up.picr.de/15343909xa.png)

Ich könnte das (im Sourcecode korrigierte und mit Doku versehene) Modul jederzeit einchecken, da sich offenbar niemand mehr anderes darum kümmert. Zumindest funktionieren sollte so ein Modul, wenn es schon im Paket mit ausgeliefert wird.
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig

> *** EN FHEM/98_SVG.pm: No document text found

SVG wird mittelfristig zu einem richtigen Modul, d.h. nicht mehr ueber weblink definiert.
Dann wird es auch eine Doku bekommen.

betateilchen

@Rudi
Dann wird ja bald alles schick :)

Du stehst als letzter Einchecker im 23_WEBTHERM.

# $Id: 23_WEBTHERM.pm 1098 2011-11-12 07:51:08Z rudolfkoenig $

Was dagegen, wenn ich das korrigierte Modul inkl. Doku einchecke?
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Markus Bloch

Zitat von: betateilchen schrieb am Di, 30 Juli 2013 15:11Ich könnte das (im Sourcecode korrigierte und mit Doku versehene) Modul jederzeit einchecken, da sich offenbar niemand mehr anderes darum kümmert. Zumindest funktionieren sollte so ein Modul, wenn es schon im Paket mit ausgeliefert wird.

Das währe doch super, dann würde sich um dieses Modul auch wieder jemand kümmern.
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

betateilchen

Na ich sag mal so zum Thema "kümmern": eine Weiterentwicklung wird es nicht geben, denn die zugrunde liegende Hardware ist bereits end-of-life seitens des Herstellers. Aber das Modul würde zumindest funktionieren und es wäre endlich dokumentiert.

So sei es...

*erledigt*
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Markus Bloch

Aber wir hätten jemand der das Modul anpassen würde, falls FHEM interne Änderungen das Modul mal zum erliegen bringen würden. Maintainer zu sein heist ja nicht, das Modul weiterzuentwickeln.
Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

betateilchen

Zitat von: betateilchen schrieb am Di, 30 Juli 2013 12:26Die komplett fehlenden Dokus habe ich aber nicht auch noch erstellt *lach*

Nun hab ich das ja doch noch gemacht *noch-mehr-lach*
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig

Ich sehe schon, ihr uebernimmt hier bald die Kontrolle...

Aber bei diesen Aenderungen habe ich nichts einzuwenden.

betateilchen

nix mit Kontrolle übernehmen, keine Sorge :)

Aber wenn mich solche Meldungen wie beim commandref_join tagelang immer wieder nerven, muss ich halt irgendwann die Ärmel hochkrempeln und das abstellen. Nur rummaulen alleine ändert ja erfahrungsgemäß nix. Stell Dir vor, Du lässt commandref_join laufen und bekommst keine einzige Fehlermeldung mehr - das wäre doch mal was...
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

betateilchen


EN FHEM/10_CUL_IR.pm: Unbalanced li (3, last line ok: 399)
*** EN FHEM/17_EGPM2LAN.pm: ignoring text due to DOS encoding
EN FHEM/10_EIB.pm: Unbalanced li (5, last line ok: 607)
EN FHEM/20_FRM_IN.pm: Unbalanced li (1, last line ok: 210)
EN FHEM/10_IT.pm: Unbalanced li (4, last line ok: 478)
*** EN FHEM/98_SVG.pm: No document text found


Es sieht ja langsam besser aus.

Aber 10_IT und 10_CUL_IR scheinen irgendwie verwaist zu sein - kümmert sich da überhaupt noch jemand drum?
Den Maintainer odroegehorn kann ich in der Mitgliederliste nicht (mehr?) finden.
Wenn nichts dagegenspricht, würde ich zumindest die fehlerhafte Doku in diesen beiden Modulen gerne korrigieren.
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig

Hallo betateilchen,

da die Herrschaften alle genuegend Zeit gehabt haben zum reparieren, und sich nicht gemeldet haben, moechte ich Dich bitten die Doku ueberall anzupassen.

Gruss,
  Rudi

betateilchen

*done*

mba:fhem.dev udo$ perl contrib/commandref_join.pl
*** EN FHEM/98_SVG.pm: No document text found
mba:fhem.dev udo$
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

rudolfkoenig