Autor Thema: Hinweis an alle Modulentwickler: neue Prüfung beim einchecken  (Gelesen 1267 mal)

Offline Markus Bloch

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 3622
Hallo zusammen,

ich möchte euch alle darauf aufmerksam machen, dass mit Revision 12018 ein neuer pre-commit Hook im SVN installiert wurde. Dadurch werden einige (oder sogar viele) von euch Fehlermeldungen beim Einchecken bekommen.

Hintergrund ist eine neue Commandref, welche im Rahmen von https://forum.fhem.de/index.php/topic,39854.msg482947.html#msg482947 implementiert wurde. Die neue modulare Commandref besitzt als Inhaltsverzeichnis eine Modulübersicht in Form einer Tabelle. Dort ist zusammen mit einem Link zur Commandref auch eine Kurzbeschreibung für jedes Modul aufgelistet.

Diese Kurzbeschreibung muss mind. in Englisch in jedem Modul vorhanden sein, damit dieses in SVN eingecheckt werden kann.

Da dies aktuell natürlich nicht überall der Fall ist, wird ein Commit nun verweigert, wenn keine Kurzbeschreibung im Modul vorhanden ist.

Um eine Kurzbeschreibung in eure Module einzufügen, müssen am Anfang der Commandref ein POD-Marker "=item summary" gesetzt werden:
Zitat
=pod
=item device
=item summary    controls LG SmartTV's build between 2012-2014 via LAN connection
=item summary_DE steuert LG SmartTV's, welche zwischen 2012-2014 hergestellt wurden, via LAN-Verbindung

=begin html
...


=pod
=item command
=item summary    shows the version of FHEM and all loaded modules.
=item summary_DE zeigt die Version von FHEM und allen geladenen Modulen an

=begin html
....

Die Kurzbeschreibung ist auf eine Zeile begrenzt und darf maximal 80 Zeichen als reinen Beschreibungstext enthalten. Es geht hierbei darum ein grobes Verständnis zu vermitteln, wofür das jeweilige Modul gedacht ist. Bei Gerätemodulen ist dies in der Regel: "welche(s) Gerät(e) von welchem Hersteller wird über welche Verbindungsart gesteuert". Bei Hilfsmodulen/Befehlsmodulen sollte entsprechend beantwortet werden, was dieses Modul grob leistet/bereitstellt. Der Modulname muss dabei in der Beschreibung nicht enthalten sein, da der Modulname direkt vor der Kurzbeschreibung als Link steht.

Bitte daher mindestens eine englische Kurzbeschreibung via "=item summary" einfügen, damit ihr eure Module wieder einchecken könnt.

Viele Grüße

Markus


Developer für Module: YAMAHA_AVR, YAMAHA_BD, FB_CALLMONITOR, FB_CALLLIST, PRESENCE, Pushsafer, LGTV_IP12, version

aktives Mitglied des FHEM e.V. (Technik)

Offline Markus M.

  • Developer
  • Hero Member
  • ****
  • Beiträge: 2765
Antw:Hinweis an alle Modulentwickler: neue Prüfung beim einchecken
« Antwort #1 am: 20 August 2016, 23:16:35 »
Danke für den Hinweis und die Beschreibung!
Für Allergy und Netatmo erledigt.
FHEM dev + HomeBridge + Lenovo Flex15 + HM-CFG-USB + RFXtrx433 + Fritz!Box 7590/7580/546E

HM Aktor/Sensor/Winmatic/Keymatic/Thermostat, HUE, Netatmo Weather/Security/Heating, Xiaomi AirPurifier/Vacuum, Withings Aura/BPM/Cardio/Go/Pulse/Thermo, VSX828, Harmony, Siro ERB15LE
https://paypal.me/mm0

Offline Sidey

  • Developer
  • Hero Member
  • ****
  • Beiträge: 2433
Antw:Hinweis an alle Modulentwickler: neue Prüfung beim einchecken
« Antwort #2 am: 14 Dezember 2019, 23:20:37 »
Hi Rudi,

ich glaube ich habe eine kleine Schwäche im precommit im Zusammenhang mit den 80 Zeichen gefunden.
Bei den 80 Zeichen, geht es doch darum, dass die Darstellung nicht gesprengt wird nehme ich an.

Folgendes funktioniert nicht, da in der Zeile mehr als 80 Zeichen stehen:

Unterstützt den gleichnamigen Low-Cost Empfänger für digitale Signale
Wenn ich die Umlaute durch ue / ae ersetze sind in der Zeile weniger als 80 Zeichen und es klappt dann:
Unterstuetzt den gleichnamigen Low-Cost Empfaenger fuer digitale Signale
Wäre es möglich die Umlaute nur als ein Zeichen zu berücksichtigen?

Grüße Sidey
Signalduino, HMLan, Raspberry Pi, Mysensors, ESPEasy, HABridge für Echo
Zustimmung Zustimmung x 1 Liste anzeigen

Offline betateilchen

  • Developer
  • Hero Member
  • ****
  • Beiträge: 16114
  • s/fhem\.cfg/configDB/g
Antw:Hinweis an alle Modulentwickler: neue Prüfung beim einchecken
« Antwort #3 am: 15 Dezember 2019, 12:58:50 »
Wäre es möglich die Umlaute nur als ein Zeichen zu berücksichtigen?

ich wäre eher für das bereits getestete Ersetzen durch ae, oe usw.
-----------------------
Unaufgeforderte Anfragen per email werden von mir nicht beantwortet. Dafür ist das Forum da.