Changes between Initial Version and Version 1 of SynBuild

Timestamp:

08/08/08 00:10:41 (16 years ago)

Author:

trac

Comment:

--

SynBuild

@@ +1 @@
+= Ontwikkelen aan de Syn-3 source tree =
+
+Alle Syn-3 software bevind zich in een hele grote SVN tree. SVN is een versie beheer systeem: het zorgt ervoor dat we met meerdere mensen tegelijk aan de zelfde files kunnen werken, en dat je elkaar nooit in de weg zit. Conflicten worden indien mogelijk automatisch opgelost en oude versies kun je altijd terug halen. (je hoeft dus nooit meer extra backups te maken). Kortom: iedereen kan precies zien wanneer wat door wie is gewijzigd.
+
+Ook bevat deze tree een groot aantal scripts om het meeste automatisch voor je te doen. Deze pagina legt je uit hoe je aan de tree komt en hoe deze is ingedeeld.
+
+== Vereisten ==
+
+Theoretisch kan Syn-3 op alle Linux omgevingen gebouwd worden, omdat pakketjes altijd in een buildroot gecompiled worden. We gebruiken momenteel Slackware, Gentoo, Syn-3 en Ubuntu omgevingen om te bouwen en dit gaat prima.
+
+Je bent in elk geval het volgende nodig: 
+
+ * root account
+ * rsync
+ * svn (Subversion)
+ * mksquashfs
+ * tar-1.13 in /bin/tar-1.13. ('''belanrijk, geattached aan deze pagina''')
+ * Mogelijkheid om loop back devices te maken.
+ * Meer dan 10 gig diskspace
+ * mkfs.xfs versie 2.9.4 of hoger. (als je usbsticks wilt maken met mkcd)
+ * 4gig vrij op je /tmp, het liefst met tmpfs. tmpfs+grote swapfile is veeel sneller dan een gewoon filesystem!
+
+= Syn-3 sources =
+
+== Toegang tot svn tree ==
+
+Je bent eerst svn inlog account nodig. Deze maakt iemand van Datux aan op twins in /home/svn/syn3/conf/. Zie SynAccounts.
+
+Toegang tot dit systeem (trac) is ook handig. Dit doet iemand met Admin rechten bij de admin pagina.
+
+Als je toegang tot trac hebt kun je via 'Browse Source' ook door de source bladeren. Ook staan er in de wiki vele verwijzigen naar files uit deze sources, wat erg handig is. 
+
+== source tree ophalen ==
+
+De eerste keer moet je een zogenaamde 'checkout' doen. Met dit commando haal je de hele tree binnen.
+
+Dit hoeft niet persee als root:
+
+{{{
+psy@krikky ~ $ svn co svn://twins.kantoor.datux.nl/syn3/trunk svnsyn3
+Authentication realm: <svn://twins.kantoor.datux.nl:3690> 32fb8cd9-e6f8-0310-8218-8ae0250c70fb
+Password for 'psy':
+Authentication realm: <svn://twins.kantoor.datux.nl:3690> 32fb8cd9-e6f8-0310-8218-8ae0250c70fb
+Username: edwin
+Password for 'edwin':
+A    svnsyn3/tests
+A    svnsyn3/tests/mailserver
+A    svnsyn3/tests/mailserver/mailtest
+A    svnsyn3/tests/mailserver/mailtest/spam.mail
+A    svnsyn3/tests/mailserver/mailtest/mailtest
+A    svnsyn3/tests/mailserver/mailtest/normal.mail
+A    svnsyn3/tests/mailserver/mailtest/virus.mail
+..duurt heel lang ;)
+}}}
+
+Druk bij het eerste password op enter, dan mag je opnieuw proberen en kan je je svn username invoeren.
+
+Na lange tijd vind je de tree onder svnsyn3.
+
+Het ip van twins.kantoor.datux.nl is momenteel '''172.16.137.102'''.
+
+== svn tree updaten ==
+
+Om de wijzigingen van andere developers binnen te halen doe je af en toe een svn update: 
+
+{{{
+root@builder:/home/psy/syn3# svn update
+U    install/install.sh
+U    install/lang_nl.sh
+U    install/lang_pl.sh
+...
+Updated to revision 3421.
+
+}}}
+
+Het is handig om dit elke dag te doen, en hierna de status te controleren
+
+== svn nieuwe files en directoryies toevoegen ==
+
+Als je een nieuw pakketje gemaakt hebt moet je deze directory markeren als toevgevoegd:
+{{{
+root@builder:/home/psy/syn3# svn add npl/internetserver/ebtables
+A      npl/internetserver/ebtables
+A      npl/internetserver/ebtables/ebtables.pkg
+A      npl/internetserver/ebtables/ebtables.version
+A      npl/internetserver/ebtables/ebtables.md5
+A      npl/internetserver/ebtables/ebtables-v2.0.8-1.tar.gz
+A      npl/internetserver/ebtables/ebtables.SlackBuild
+A      npl/internetserver/ebtables/ebtables.arch
+}}}
+
+Dit gebeurd alleen lokaal, pas bij het committen (zie verderop) word de data ook naar de centrale server gestuurd.
+
+== svn status controleren ==
+
+Om te zien of het updaten goed gegaan is en om te zien of je wijzigingen gemaakt hebt gebruik je svn status. Dit commando laat de '''locale''' status van je tree zien en doet dus niks met de server:
+
+{{{
+root@builder:/home/psy/syn3# svn status
+?      test
+?      npl/bla
+A      npl/internetserver/ebtables
+A      npl/internetserver/ebtables/ebtables.pkg
+A      npl/internetserver/ebtables/ebtables.version
+A      npl/internetserver/ebtables/ebtables.md5
+A      npl/internetserver/ebtables/ebtables-v2.0.8-1.tar.gz
+A      npl/internetserver/ebtables/ebtables.SlackBuild
+A      npl/internetserver/ebtables/ebtables.arch
+M      npl/mailserver/syncml_openxchange/syncml_openxchange.SlackBuild
+...
+}}}
+
+
+De eerste en tweede kolom zijn het belangrijkste, zie ook svn status --help:
+
+    First column: Says if item was added, deleted, or otherwise changed
+    *  ' ' no modifications
+    *  'A' Added
+    *  ''''C' Conflicted'''
+    *  'D' Deleted
+    *  'I' Ignored
+    *  'M' Modified
+    *  'R' Replaced
+    *  'X' item is unversioned, but is used by an externals definition
+    *  '?' item is not under version control
+    *  '!' item is missing (removed by non-svn command) or incomplete
+    *  '~' versioned item obstructed by some item of a different kind
+
+    Second column: Modifications of a file's or directory's properties
+    *  ' ' no modifications
+    *  ''''C' Conflicted'''
+    *  'M' Modified
+
+Let er dus op dat je geen conflicten hebt. Als je dit wel hebt is het het handigste om de conflicteren de file en bijbehorden troep weg te halen en nogmaals update te doen. Een andere optie bij tekstfiles is de boel handmatig mergen.
+
+== Wijzgingen opslaan op svn server ==
+
+Als je een aantal wijzigingen gemaakt hebt moet je deze committen (opslaan), onder volgende voorwaarden:
+
+ * Het gewijzigde onderdeel moet compleet zijn en het liefst als 1 geheel gecommit worden. (tenzij je een dag werk hebt, dan mag je een backup-commit doen)
+ * Niet meer dan 1 onderdeel of wijziging tegelijk committen, bij iedere wijziging duidelijk commentaar!
+ * Er moet niks stuk gaan waar anderen van afhankelijk zijn.
+ * Nieuwe onderdelen op de juiste plek in de tree adden. (eventueel vragen aan edwin) Verderop vind je een overzicht van de tree indeling.
+ * Indien het een pakket betreft, dit pakket eerst rebuilden alvorens te committen indien mogelijk.
+
+Stel we hebben de volgende status:
+{{{
+root@builder:/home/psy/syn3/npl/internetserver# svn status
+A      ebtables
+A      ebtables/ebtables.pkg
+A      ebtables/ebtables.version
+A      ebtables/ebtables.md5
+A      ebtables/ebtables-v2.0.8-1.tar.gz
+A      ebtables/ebtables.SlackBuild
+A      ebtables/ebtables.arch
+A      arptables
+A      arptables/arptables.version
+A      arptables/arptables.md5
+A      arptables/arptables-v0.0.3-2.tar.gz
+A      arptables/arptables.SlackBuild
+A      arptables/arptables.arch
+A      arptables/arptables.pkg
+}}}
+Zo te zien heb ik 2 nieuwe pakketjes gemaakt, er zijn dus 2 commits nodig:
+{{{
+root@builder:/home/psy/syn3/npl/internetserver# cd ebtables/
+root@builder:/home/psy/syn3/npl/internetserver/ebtables# svn commit -m 'nieuwe pakketje, nodig voor ethernet bridging en firewalling'
+Adding         ebtables
+Adding  (bin)  ebtables/ebtables-v2.0.8-1.tar.gz
+Adding         ebtables/ebtables.SlackBuild
+Adding         ebtables/ebtables.arch
+Adding         ebtables/ebtables.md5
+Adding  (bin)  ebtables/ebtables.pkg
+Adding         ebtables/ebtables.version
+Transmitting file data ......
+Committed revision 3422.
+root@builder:/home/psy/syn3/npl/internetserver/ebtables# cd ../arptables/
+root@builder:/home/psy/syn3/npl/internetserver/arptables# svn commit -m 'nieuw pakketje, nodig voor firewalling van arp pakketjes'
+Adding         arptables
+Adding  (bin)  arptables/arptables-v0.0.3-2.tar.gz
+Adding         arptables/arptables.SlackBuild
+Adding         arptables/arptables.arch
+Adding         arptables/arptables.md5
+Adding  (bin)  arptables/arptables.pkg
+Adding         arptables/arptables.version
+Transmitting file data ......
+Committed revision 3423.
+root@builder:/home/psy/syn3/npl/internetserver/arptables#
+}}}
+
+'''Let op:''' Als je eenmaal iets commit, kan dit nooit meer uit de history verwijderd worden. File en directorys kun je wel uit de tree verwijderen, maar ze blijven uiteraard bestaan in de oude revisie.
+
+=== Wijzigingen opslaan terwijl je geen rechten hebt ===
+
+Als je geen schrijfrechten hebt in de syn3 tree, kun je je wijzigingen op de volgende manier opslaan in een patch file:
+{{{
+psy /home/psy/syn3/npl # svn diff > bugfix-ldap.patch
+}}}
+
+Deze file kun je opsturen naar info@datux.nl, waarna hij gereviewed word en eventueel in de tree opgenomen word. Binary files worden niet meegenomen in een diff, daarom is het altijd van belang de orginele url mee naar de sourcefiles mee te sturen!
+
+== Een fork maken ==
+
+Soms kan het handig zijn een zogenaamde ''fork'' te maken. Jou wijzigingen worden dan gecommit in je eigen svn tree, zodat anderen er geen last van hebben. Zo kan je zoveel prutsen als je wilt, en als je klaar bent voeg je je wijzigingen weer toe aan de hoofd tree (trunk).
+
+'''Voorbeelden en uitleg nodig!'''
+
+= Meer info =
+
+Voor meer info zie over de indeling van de source tree zie SynTree.