SVN Nutzungsregeln - Versionsgeschichte

Herrmannj am 11. Mai 2021 um 21:19 Uhr

2021-05-11T21:19:54Z

← Nächstältere Version		Version vom 11. Mai 2021, 23:19 Uhr
Zeile 163:		Zeile 163:

	Beispiel:		Beispiel:
			<syntaxhighlight lang="bash">
	cd /opt/fhem		cd /opt/fhem
	svn commit -m "XX_YYYYY.pm: was_wurde_geändert (Forum #12345)" FHEM/XX_YYYYY.pm		svn commit -m "XX_YYYYY.pm: was_wurde_geändert (Forum #12345)" FHEM/XX_YYYYY.pm
			</syntaxhighlight>

	[[Kategorie:Development]]		[[Kategorie:Development]]

Herrmannj: svn terminal cmd add

2021-05-11T21:18:13Z

svn terminal cmd add

← Nächstältere Version		Version vom 11. Mai 2021, 23:18 Uhr
Zeile 159:		Zeile 159:

	Diese $Id$-Zeile ist wichtig, denn sie dient dem FHEM-Kommando <code>version</code> als Grundlage um die Version aller Module zu ermitteln. Ein Modul welches entweder den Platzhalter als Kommentar nicht beinhaltet, oder die SVN-Property svn:keywords nicht angepasst hat, wird beim Check-In verweigert und abgelehnt.		Diese $Id$-Zeile ist wichtig, denn sie dient dem FHEM-Kommando <code>version</code> als Grundlage um die Version aller Module zu ermitteln. Ein Modul welches entweder den Platzhalter als Kommentar nicht beinhaltet, oder die SVN-Property svn:keywords nicht angepasst hat, wird beim Check-In verweigert und abgelehnt.

			== Commit Befehl im Terminal ==

			Beispiel:

			cd /opt/fhem
			svn commit -m "XX_YYYYY.pm: was_wurde_geändert (Forum #12345)" FHEM/XX_YYYYY.pm

	[[Kategorie:Development]]		[[Kategorie:Development]]

Markusbloch: Anpassung von -Tags nach

2017-07-26T18:01:14Z

Anpassung von <source>-Tags nach <syntaxhighlight>

← Nächstältere Version		Version vom 26. Juli 2017, 20:01 Uhr
Zeile 113:		Zeile 113:

	Dazu ist ein Kommentar im jeweiligen Modul als Kommentar notwendig. Am besten als Kopfzeile folgendes einfügen:		Dazu ist ein Kommentar im jeweiligen Modul als Kommentar notwendig. Am besten als Kopfzeile folgendes einfügen:
	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	# $Id$		# $Id$

Zeile 121:		Zeile 121:
	use warnings;		use warnings;

	...</~~source~~>		...</syntaxhighlight>


Zeile 146:		Zeile 146:
	Nun kann man das Modul einchecken. Beim Check-In wird dann der $Id$-Platzhalter durch beispielhaft folgende Zeile ersetzt:		Nun kann man das Modul einchecken. Beim Check-In wird dann der $Id$-Platzhalter durch beispielhaft folgende Zeile ersetzt:

	<~~source~~ lang="perl">		<syntaxhighlight lang="perl">
	# $Id: 10_MODULE.pm 10475 2016-01-12 18:51:31Z svn-username $		# $Id: 10_MODULE.pm 10475 2016-01-12 18:51:31Z svn-username $

Zeile 155:		Zeile 155:

	...		...
	</~~source~~>		</syntaxhighlight>


	Diese $Id$-Zeile ist wichtig, denn sie dient dem FHEM-Kommando <code>version</code> als Grundlage um die Version aller Module zu ermitteln. Ein Modul welches entweder den Platzhalter als Kommentar nicht beinhaltet, oder die SVN-Property svn:keywords nicht angepasst hat, wird beim Check-In verweigert und abgelehnt.		Diese $Id$-Zeile ist wichtig, denn sie dient dem FHEM-Kommando <code>version</code> als Grundlage um die Version aller Module zu ermitteln. Ein Modul welches entweder den Platzhalter als Kommentar nicht beinhaltet, oder die SVN-Property svn:keywords nicht angepasst hat, wird beim Check-In verweigert und abgelehnt.
	[[Kategorie:Development]]		[[Kategorie:Development]]

Markusbloch: /* Welche Files darf ich bearbeiten, welche nicht? */ Anpassung der Links an neues SVN (https://forum.fhem.de/index.php/topic,67948.0.html)

2017-02-26T11:10:21Z

Welche Files darf ich bearbeiten, welche nicht?: Anpassung der Links an neues SVN (https://forum.fhem.de/index.php/topic,67948.0.html)

← Nächstältere Version		Version vom 26. Februar 2017, 13:10 Uhr
Zeile 22:		Zeile 22:
	Generell gilt, jeder bearbeitet nur Dateien, die er selber beigesteuert hat. Das Anpassen von fremdem Modulen ohne Einverständnis des Eigentümers ist strikt untersagt!		Generell gilt, jeder bearbeitet nur Dateien, die er selber beigesteuert hat. Das Anpassen von fremdem Modulen ohne Einverständnis des Eigentümers ist strikt untersagt!

	Im SVN gibt es die Datei [https://~~sourceforge~~.~~net/p/~~fhem/~~code/HEAD~~/~~tree~~/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] in der die Zuständigkeiten für alle Module, Dateien und Verzeichnisse festgehalten sind.		Im SVN gibt es die Datei [https://svn.fhem.de/trac/browser/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] in der die Zuständigkeiten für alle Module, Dateien und Verzeichnisse festgehalten sind.

	Folgende Dateien dürfen von allen Entwicklern bearbeitet werden:		Folgende Dateien dürfen von allen Entwicklern bearbeitet werden:

	* [https://~~sourceforge~~.~~net/p/~~fhem/~~code/HEAD~~/~~tree~~/trunk/fhem/CHANGED CHANGED] - kurz und knappe Einträge von nutzerrelevanten Änderungen an FHEM		* [https://svn.fhem.de/trac/browser/trunk/fhem/CHANGED CHANGED] - kurz und knappe Einträge von nutzerrelevanten Änderungen an FHEM
	* [https://~~sourceforge~~.~~net/p/~~fhem/~~code/HEAD~~/~~tree~~/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] - Eintrag/Änderungen von EIGENEN!!! Modulen		* [https://svn.fhem.de/trac/browser/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] - Eintrag/Änderungen von EIGENEN!!! Modulen

	== Vorgehensweisen ==		== Vorgehensweisen ==

Trelle: /* Welche Files darf ich bearbeiten, welche nicht? */ ergänzt wg. https://forum.fhem.de/index.php/topic,67880.msg593772.html#msg593772

2017-02-25T19:26:00Z

Welche Files darf ich bearbeiten, welche nicht?: ergänzt wg. https://forum.fhem.de/index.php/topic,67880.msg593772.html#msg593772

← Nächstältere Version		Version vom 25. Februar 2017, 21:26 Uhr
Zeile 22:		Zeile 22:
	Generell gilt, jeder bearbeitet nur Dateien, die er selber beigesteuert hat. Das Anpassen von fremdem Modulen ohne Einverständnis des Eigentümers ist strikt untersagt!		Generell gilt, jeder bearbeitet nur Dateien, die er selber beigesteuert hat. Das Anpassen von fremdem Modulen ohne Einverständnis des Eigentümers ist strikt untersagt!

	Im SVN gibt es die Datei [https://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] in der die Zuständigkeiten für alle Module/Dateien festgehalten sind.		Im SVN gibt es die Datei [https://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/MAINTAINER.txt MAINTAINER.txt] in der die Zuständigkeiten für alle Module, Dateien und Verzeichnisse festgehalten sind.

	Folgende Dateien dürfen von allen Entwicklern bearbeitet werden:		Folgende Dateien dürfen von allen Entwicklern bearbeitet werden:

Markusbloch: /* Neues Modul */

2016-12-11T17:36:14Z

Neues Modul

← Nächstältere Version		Version vom 11. Dezember 2016, 19:36 Uhr
Zeile 33:		Zeile 33:
	Bei einem neuen Modul gilt es zwischen zwei Ausgangsszenarien zu unterscheiden. Hierbei ist entscheiden, ob man bereits einen schreibenden Zugriff auf das FHEM SVN-Repository, sowie Zugang zum FHEM Developer Bereich im Forum besitzt, oder nicht.		Bei einem neuen Modul gilt es zwischen zwei Ausgangsszenarien zu unterscheiden. Hierbei ist entscheiden, ob man bereits einen schreibenden Zugriff auf das FHEM SVN-Repository, sowie Zugang zum FHEM Developer Bereich im Forum besitzt, oder nicht.

	Sollte man noch keinen Zugriff auf das [https://svn.fhem.de FHEM SVN Repository] haben, so kann man diesen per Mail beantragen (siehe dazu: [[#Wie_bekomme_ich_einen_Schreibzugriff_auf_das_SVN.3F Wie bekomme ich einen Schreibzugriff auf das SVN?]]). Dabei ist es hilfreich einen Link zu dem neuen Modul der Anmeldung beizufügen oder dem Forums-Beitrag in dem das Modul bereits durch einzelne User positiv getestet wurde. Genauere Hinweise welche Voraussetzungen für die Aufnahme als Modulentwickler gelten sind im {{Link2Forum\|Topic=18962\|LinkText=Developer-Bereich}} im Forum dokumentiert.		Sollte man noch keinen Zugriff auf das [https://svn.fhem.de FHEM SVN Repository] haben, so kann man diesen per Mail beantragen (siehe dazu: [[#Wie_bekomme_ich_einen_Schreibzugriff_auf_das_SVN.3F\|Wie bekomme ich einen Schreibzugriff auf das SVN?]]). Dabei ist es hilfreich einen Link zu dem neuen Modul der Anmeldung beizufügen oder dem Forums-Beitrag in dem das Modul bereits durch einzelne User positiv getestet wurde. Genauere Hinweise welche Voraussetzungen für die Aufnahme als Modulentwickler gelten sind im {{Link2Forum\|Topic=18962\|LinkText=Developer-Bereich}} im Forum dokumentiert.

	Wer bereits einen Schreibzugriff auf das FHEM SVN-Repository besitzt, kann ein neues Modul selbstständig einchecken. Auch hier gelten die Hinweise für Entwickler aus dem {{Link2Forum\|Topic=18962\|LinkText=Developer Bereich}}.		Wer bereits einen Schreibzugriff auf das FHEM SVN-Repository besitzt, kann ein neues Modul selbstständig einchecken. Auch hier gelten die Hinweise für Entwickler aus dem {{Link2Forum\|Topic=18962\|LinkText=Developer Bereich}}.

Markusbloch: /* Neues Modul */ Anpassung an neues Repository

2016-12-11T17:35:36Z

Neues Modul: Anpassung an neues Repository

← Nächstältere Version		Version vom 11. Dezember 2016, 19:35 Uhr
Zeile 33:		Zeile 33:
	Bei einem neuen Modul gilt es zwischen zwei Ausgangsszenarien zu unterscheiden. Hierbei ist entscheiden, ob man bereits einen schreibenden Zugriff auf das FHEM SVN-Repository, sowie Zugang zum FHEM Developer Bereich im Forum besitzt, oder nicht.		Bei einem neuen Modul gilt es zwischen zwei Ausgangsszenarien zu unterscheiden. Hierbei ist entscheiden, ob man bereits einen schreibenden Zugriff auf das FHEM SVN-Repository, sowie Zugang zum FHEM Developer Bereich im Forum besitzt, oder nicht.

	Sollte man noch keinen Zugriff auf das FHEM SVN Repository haben, so kann man diesen ~~bei den zuständigen Repository-Maintainern~~ beantragen. Dabei ist es hilfreich einen Link zu dem neuen Modul der Anmeldung beizufügen oder dem Forums-Beitrag in dem das Modul bereits durch einzelne User positiv getestet wurde. Genauere Hinweise welche Voraussetzungen für die Aufnahme als Modulentwickler gelten sind im {{Link2Forum\|Topic=18962\|LinkText=Developer-Bereich}} im Forum dokumentiert.		Sollte man noch keinen Zugriff auf das [https://svn.fhem.de FHEM SVN Repository] haben, so kann man diesen per Mail beantragen (siehe dazu: [[#Wie_bekomme_ich_einen_Schreibzugriff_auf_das_SVN.3F Wie bekomme ich einen Schreibzugriff auf das SVN?]]). Dabei ist es hilfreich einen Link zu dem neuen Modul der Anmeldung beizufügen oder dem Forums-Beitrag in dem das Modul bereits durch einzelne User positiv getestet wurde. Genauere Hinweise welche Voraussetzungen für die Aufnahme als Modulentwickler gelten sind im {{Link2Forum\|Topic=18962\|LinkText=Developer-Bereich}} im Forum dokumentiert.

	Wer bereits einen Schreibzugriff auf das FHEM SVN-Repository besitzt, kann ein neues Modul selbstständig einchecken. Auch hier gelten die Hinweise für Entwickler aus dem {{Link2Forum\|Topic=18962\|LinkText=Developer Bereich}}.		Wer bereits einen Schreibzugriff auf das FHEM SVN-Repository besitzt, kann ein neues Modul selbstständig einchecken. Auch hier gelten die Hinweise für Entwickler aus dem {{Link2Forum\|Topic=18962\|LinkText=Developer Bereich}}.

Markusbloch: /* Wie bekomme ich einen Schreibzugriff auf das SVN? */ Anpassung an neues SVN-Repository

2016-12-11T17:32:39Z

Wie bekomme ich einen Schreibzugriff auf das SVN?: Anpassung an neues SVN-Repository

← Nächstältere Version		Version vom 11. Dezember 2016, 19:32 Uhr
Zeile 9:		Zeile 9:
	* Support von Usern im FHEM-Forum zu Fragen des Moduls		* Support von Usern im FHEM-Forum zu Fragen des Moduls

	Sollte dies der Fall sein, bitte ~~direkten Kontakt mit Rudolf König oder Dr~~. ~~Boris Neubert aufnehmen~~ mit folgenden Infos:		Sollte dies der Fall sein, bitte eine Email an [mailto:svn@fhem.de svn@fhem.de] schicken mit den folgenden Infos:

	* kurze Modulerklärung		* kurze Modulerklärung
	* Link zum aktuellen Modul (FHEM Forum-Thread, ...)		* Link zum aktuellen Modul (FHEM Forum-Thread, ...)
	* SourceForge Username
	* FHEM Forum Username		* FHEM Forum Username
			* SSH Public-Key zur Authentifizierung (siehe https://svn.fhem.de/)

	Sofern alles passt, wird dem ~~SourceForge~~ Username der Schreibzugriff gewährt und man kann sein Modul einchecken		Sofern alles passt, wird dem Username der Schreibzugriff gewährt und man kann sein Modul einchecken.

	== Welche Files darf ich bearbeiten, welche nicht? ==		== Welche Files darf ich bearbeiten, welche nicht? ==

Markusbloch: /* Nummernpräfix bei Modulen darf nicht "99" sein */

2016-10-31T08:32:55Z

Nummernpräfix bei Modulen darf nicht "99" sein

← Nächstältere Version		Version vom 31. Oktober 2016, 10:32 Uhr
Zeile 79:		Zeile 79:
	== Nummernpräfix bei Modulen darf nicht "99" sein ==		== Nummernpräfix bei Modulen darf nicht "99" sein ==

	Jedes FHEM-Modul muss im Dateinamen immer ein 2-stelliges Nummernpräfix enthalten. Diese Zahl ~~dient bei~~ [[DevelopmentModuleIntro#Zweistufiges_Modell_für_Module\|zweistufigen Modulen]] ~~zur Definition der Reihenfolge in der IO-Module sämtliche Client-Module zur Verarbeitung von anstehenden Daten prüfen. Das Präfix "99" hat hierbei eine besondere Eigenschaft~~. ~~Alle Module~~ die ~~mit dem Präfix "99" versehen sind, werden beim Start von FHEM automatisch geladen. Dieses ist historisch bedingt um z.B. die 99_myUtils.pm immer zu laden~~.		Jedes FHEM-Modul muss im Dateinamen immer ein 2-stelliges Nummernpräfix enthalten. Diese Zahl war früher für die Reihenfolge der Prüfung der [[DevelopmentModuleIntro#Die_Client-Liste\|Client-Liste]] in [[DevelopmentModuleIntro#Zweistufiges_Modell_für_Module\|zweistufigen Modulen]] zuständig. Heute besitzen die Modulnummern diese Funktion nicht mehr.

	Das Präfix "99" ist jedoch zur weiteren Verwendung gesperrt um ein automatisches Laden von weiteren Modulen zu verhindern. Generell werden in FHEM Module bei der erstmaligen ~~Definition~~ automatisch geladen.		Das Präfix "99" hat aber eine besondere Eigenschaft. Alle Module die mit dem Präfix "99" versehen sind, werden beim Start von FHEM automatisch geladen. Dieses ist historisch bedingt um z.B. die 99_myUtils.pm immer zu laden.

			Das Präfix "99" ist jedoch zur weiteren Verwendung gesperrt um ein automatisches Laden von weiteren Modulen zu verhindern. Generell werden in FHEM Module bei der erstmaligen Verwendung automatisch geladen.

	Neue Module, die das Nummernpräfix "99" tragen (z.B. "99_MyModule.pm") werden beim Check-In zurückgewiesen.		Neue Module, die das Nummernpräfix "99" tragen (z.B. "99_MyModule.pm") werden beim Check-In zurückgewiesen.

Markusbloch: /* Technische Regeln */ Hinzufügen der 99'er-Regelung beim SVN Checkin.

2016-10-17T21:28:43Z

Technische Regeln: Hinzufügen der 99'er-Regelung beim SVN Checkin.

← Nächstältere Version		Version vom 17. Oktober 2016, 23:28 Uhr
Zeile 76:		Zeile 76:

	Wenn eine Commit-Message nicht diesem Format entspricht, wird ein Commit verweigert.		Wenn eine Commit-Message nicht diesem Format entspricht, wird ein Commit verweigert.

			== Nummernpräfix bei Modulen darf nicht "99" sein ==

			Jedes FHEM-Modul muss im Dateinamen immer ein 2-stelliges Nummernpräfix enthalten. Diese Zahl dient bei [[DevelopmentModuleIntro#Zweistufiges_Modell_für_Module\|zweistufigen Modulen]] zur Definition der Reihenfolge in der IO-Module sämtliche Client-Module zur Verarbeitung von anstehenden Daten prüfen. Das Präfix "99" hat hierbei eine besondere Eigenschaft. Alle Module die mit dem Präfix "99" versehen sind, werden beim Start von FHEM automatisch geladen. Dieses ist historisch bedingt um z.B. die 99_myUtils.pm immer zu laden.

			Das Präfix "99" ist jedoch zur weiteren Verwendung gesperrt um ein automatisches Laden von weiteren Modulen zu verhindern. Generell werden in FHEM Module bei der erstmaligen Definition automatisch geladen.

			Neue Module, die das Nummernpräfix "99" tragen (z.B. "99_MyModule.pm") werden beim Check-In zurückgewiesen.

	== CHANGED Eintrag ==		== CHANGED Eintrag ==