FHEM Forum

FHEM - Entwicklung => FHEM Development => Thema gestartet von: Markus Bloch am 01 April 2016, 17:50:48

Titel: Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 01 April 2016, 17:50:48
Hallo zusammen,

ich habe aufgrund einiger neu hinzugekommenen Regeln bei der SVN Nutzung einen Wiki-Artikel zur SVN Nutzung verfasst:

http://www.fhemwiki.de/wiki/SVN_Nutzungsregeln

Ich würde euch bitten, da mal drüber zu schauen, ob das alles verständlich/vollständig ist.

Kritik/Kommentare sind herzlich willkommen.

Vielen Dank

Gruß
Markus
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: HCS am 01 April 2016, 18:02:36
Ich finde es verständlich und übersichtlich. Ob es vollständig ist, vermag ich nicht zu 100% beurteilen.
Gab es da nicht noch Regeln, die den Comment beim svn checkin prüfen?
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 01 April 2016, 18:20:09
Stimmt, ganz vergessen. Siehst du, gut das du es gesagt hast :-)

Hab ich ergänzt.

Gruß
Markus
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: rudolfkoenig am 01 April 2016, 19:06:00
Finde ich auch sehr schoen. Ich wuerde noch erwaehnen, dass man vor dem Einchecken generell ein "svn diff" machen, und die Ausgabe durchlesen sollte: das verhindert, dass man Unbeabsichtigtes eincheckt, und man kann nochmal kurz ueber die Aenderungen nachdenken :)
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 01 April 2016, 19:22:33
Habe ich noch als grüne Info-Box spendiert.

Gruß
Markus
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Risiko am 01 April 2016, 20:52:17
Für mich auch völlig verständlich. Super Arbeit.
Hätte ich auch gern am Anfang gehabt  ;)
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Dr. Boris Neubert am 02 April 2016, 09:14:50
Danke, Markus.

Ich meine, dass es noch weitere (nicht unumstrittene) pre-commit hooks gibt außer den Check auf einen syntaxkonformen Kommentar und das Vorhandensein der Id. Leider habe ich nach 5 Minuten Suche bei SF immer noch nicht die Stelle gefunden, wo man das einstellen/einsehen kann, sonst hätte ich die Regelungen hier gepostet.

Kann mir bitte jemand sagen, wo die pre-commit hooks definiert werden? Danke.

Viele Grüße
Boris
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: dev0 am 02 April 2016, 09:45:23
Ich fände einen kuzen step-by-step svn command line guide zum (erstmaligen) einchecken noch hilfreich. Falls das schon an anderer Stelle beschrieben ist, dann habe ich es nicht gefunden und ein Link dorthin würde helfen.

/Uli
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: zap am 02 April 2016, 14:22:58
Ich hatte mal <div> ziemlich am Anfang der Commmandref stehen. Wurde auch korrekt am Ende geschlossen. Das Commit war erst möglich, nachdem ich die divs entfernt hatte.

Grundsätzlich zum Einchecken eines neuen Moduls: Ich hatte mal irgendwo gelesen, dass man erst um Erlaubnis fragen muss, bevor man ein neues Modul in den FHEM Zweig eincheckt (nicht im Contrib). Davon steht im Wiki Artikel nichts. Gilt das nicht mehr?

VG Dirk
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: rudolfkoenig am 02 April 2016, 16:40:01
ZitatDas Commit war erst möglich, nachdem ich die divs entfernt hatte.
Das ist nicht unbedingt noetig, es sei denn, die divs haben Attribute (z.Bsp. Style). Style gehoert meiner Ansicht nach ins CSS und nicht in die Tags.

Zitaterst um Erlaubnis fragen muss, bevor man ein neues Modul in den FHEM Zweig eincheckt
Das ist nicht noetig, es sei denn, man will Bibliotheken anschleppen, ader neue Verzeichnisse anlegen.
Beide sind keine reine Formalien, und es wird darueber ernst nachgedacht, ob es notwendig ist.
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: rudolfkoenig am 02 April 2016, 17:01:12
ZitatLeider habe ich nach 5 Minuten Suche bei SF immer noch nicht die Stelle gefunden, wo man das einstellen/einsehen kann, sonst hätte ich die Regelungen hier gepostet.
Soweit mir bekannt, kann man die Regeln nur ueber ein shell-account setzen.
Eine Kopie der Datei ist in contrib/pre-commit
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Dr. Boris Neubert am 02 April 2016, 21:56:42
Danke, Rudi, gucke ich mir mal an.

Christian hat noch vorgeschlagen, in die SVN-Doku aufzunehmen, dass bei gravierenden Änderungen ein Beitrag im Board Ankündigungen erstellt wird.

Weil nach einem Tutorial gefragt wurde: ich lese das hier http://svnbook.red-bean.com/index.de.html (http://svnbook.red-bean.com/index.de.html)
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: viegener am 03 April 2016, 13:12:58
Klasse Arbeit, das baut auch weiter Einstiegshürden ab!

Einträge im Board Ankündigungen bei grossen Änderungen finde ich sehr erwähnenswert, auch wenn natürlich nicht alle die Ankündigungen lesen  ;)

Sollte noch etwas zu contrib aufgenommen werden (also z.B. Unterschied zwischen contrib und "offiziellen" Modulen oder Wo gehört anderer Content hin, also Firmwares/Bilder/...). Aber vielleicht wäre das einen eigenen Artikel wert?
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Dr. Boris Neubert am 03 April 2016, 13:37:00
Hallo,

hier die Liste der Prüfungen, die beim Checkin vorgenommen werden.

Grüße
Boris


A FHEM SVN comment must have the following format
  module: text-describing-the-change
or
  module: text-describing-the-change (Forum #<forum.fhem.de threadnumber>)


CHANGED file must not contain tabulators

CHANGED file must not have over 80 characters per line

Files FHEM/*.pm must have SVN Id

No DOS line encoding for files FHEM/*.pm

Files FHEM/*.pm must have empty line after =begin html

Files FHEM/*.pm with =begin html must contain content and <a name="...">...</a> link

No unbalanced tags in documentation in FHEM/*.pm
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 03 April 2016, 13:58:09
Zitat von: Dr. Boris Neubert am 03 April 2016, 13:37:00
Hallo,

hier die Liste der Prüfungen, die beim Checkin vorgenommen werden.

Grüße
Boris


A FHEM SVN comment must have the following format
  module: text-describing-the-change
or
  module: text-describing-the-change (Forum #<forum.fhem.de threadnumber>)


CHANGED file must not contain tabulators

CHANGED file must not have over 80 characters per line

Files FHEM/*.pm must have SVN Id

No DOS line encoding for files FHEM/*.pm

Files FHEM/*.pm must have empty line after =begin html

Files FHEM/*.pm with =begin html must contain content and <a name="...">...</a> link

No unbalanced tags in documentation in FHEM/*.pm

Ist alles im Artikel erfasst und erklärt. Sollte noch weiterer Bedarf, dann gerne Bescheid sagen.

Gruß
Markus
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 03 April 2016, 14:07:37
Zitat von: rudolfkoenig am 02 April 2016, 16:40:01
Das ist nicht noetig, es sei denn, man will Bibliotheken anschleppen, ader neue Verzeichnisse anlegen.
Beide sind keine reine Formalien, und es wird darueber ernst nachgedacht, ob es notwendig ist.

Ich habe im Wiki daher noch folgenden Satz bei "Neues Modul" spendiert:

ZitatEine Ausnahme bilden hier Module, die auf weitere Perl-Module/Dateien/Binaries angewiesen sind, welche demnach mit eingecheckt werden müssten. Da solche Konstellationen generell unerwünscht ist, sollte man entweder mit den Repository-Maintainern Kontakt aufnehmen um das weitere Vorgehen zu besprechen, oder besser ganz auf solche Abhängigkeiten verzichten.

Gruß
Markus
Titel: Antw:Wiki-Artikel zu SVN Nutzungsregeln
Beitrag von: Markus Bloch am 07 April 2016, 21:49:19
Zitat von: Dr. Boris Neubert am 02 April 2016, 21:56:42
Christian hat noch vorgeschlagen, in die SVN-Doku aufzunehmen, dass bei gravierenden Änderungen ein Beitrag im Board Ankündigungen erstellt wird.

Habe ich soeben eingearbeitet.

Gruß
Markus