Genj - Développement

Un article de Arvernes Wiki.

Pour pouvoir commencer à participer au développement de GenJ, il vous faut le code source du logiciel.

Avec GenJ, aucun problème pour l'obtenir, GenJ est un logiciel Open Source, donc le code source est librement disponible sous licence GPL. Plusieurs explications vous sont données sur ce qu'est la licence GPL. Une traduction est également à votre disposition.

Sommaire

L'accés CVS

L’accès CVS va vous permettre de récupérer le code source de GenJ, pour soit :

  • recompiler ce code sur votre machine par l’intermédiaire d’un script qui est fourni, et donc utiliser la toute dernière version disponible de GenJ. Pour faire ceci, vous n’avez pas besoin d’un accés complet. Un accès ‘anonymous’ (anonyme) est largement suffisant.
  • soit pour, à partir du code source, faire des modifications, pour améliorer GenJ, rajouter des fonctionnalités, etc... et remonter sur le site de stockage du code source que j’appelerai ‘repository’, comme en anglais, pour que tout le monde puisse en profiter, que ce soit les autres utilisateurs, mais aussi les autres développeurs, pour à partir de vos modifications, éventuellement, refaire d’autres développements, etc.... pour toujours améliorer le logiciel. Là vous avez besoin d’un accès complet ‘full access’.

Ce qui est indispensable

Veuillez vous assurer que votre système remplit les conditions suivantes :

  • J2SE pour votre OS (Windows, Linux, OS2, etc...) est installé.
  • La variable %JAVA_HOME% (ou $JAVA_HOME sur un système Unix) est définie et pointe correctement sur le répertoire où est installé le J2SE
  • CVS est installé (c’est l’instrument indispensable pour accéder au site de dépôt du code source)[1].
  • SSH est installé (il est utilisé pour le codage des données quand vous accédez au site de Sourceforge)

Accès CVS en tant qu'utilisateur Anonyme

Pour reconstruire GenJ sur votre machine, vous devez suivre les étapes suivantes :

$ cd **genj-source-directory**
$ cvs -d:pserver:genj.cvs.sourceforge.net:/cvsroot/genj co -P dev/app
$ cd dev/app
$ ./build clean
$ ./build run

Accès CVS complet

Si vous voulez aider, participer au développement de GenJ, veuillez contacter nmeier at users dot sourceforge dot net. Aprés vous être enregistré sur Sourceforge et une fois que vous avez obtenu l’accés complet sur CVS, loguez vous une fois sur le shell.sourceforge.net via:

$ ssh -l **sourceforge-username** shell.sourceforge.net

Votre compte est maintenant initialisé et vous pouvez commencer à travailler. Le processus sera grosso modo le suivant (mais il vous faudra l’adapter en fonction de votre plateforme, si ce n’est pas un système Windows):

$ cd **local-genj-cvs-directory**
$ set cvs_rsh=ssh
$ set cvsroot=:ext:**sourceforge-username**@genj.cvs.sourceforge.net:/cvsroot/genj
$ cvs co -P dev/app
$ cd ./dev/app/doc
$ vi readme1st.txt
$ cvs ci readme1st.txt

La partie principale de l’API de GenJ (Gedcom, Rapports, IO, etc.) est disponible au travers de GenJ API Javadoc. Assurez-vous que vous avez jeté un coup d’oeil sur la documentation pour l’accés CVS et n’hésitez pas à poser vos questions par le biais du Forum.

Veuillez suivre ces lignes de conduite quand vous travaillez avec cvs :

  1. utilisez ‘cvs checkout’, ‘cvs checkin’, ‘cvs update’ selon ce que vous désirez faire
  2. n’utilisez pas ‘cvs admin’, ‘cvs add’, ‘cvs remove’ car il est trés difficile de revenir en arrière pour corriger d’éventuels problèmes sur le site, si quelque chose n’a pas bien fonctionné
  3. mettez les commentaires appropriés quand vous remontez quelque chose sur le site (check in)
  4. utilisez un éditeur qui soit neutre par rapport au fichier que vous modifiez (donc qui ne rajoute pas des quantités de code du genre de Word) et qui peut supporter l’encodage UTF-8 (je vous conseille l’éditeur sous Java : Jedit. Un must)
  5. d’une manière générale, comportez vous normalement, et prenez beaucoup de plaisir. Votre aide est précieuse et elle sera la bienvenue. Tous les utilisateurs de GenJ, ne pourront que vous être reconnaissant de votre participation au logiciel. :)

IDE - Environnement de Développement Intégré

Un IDE (Integrated Development Environment) va vous permettre de développer votre application java dans un environnement convivial et puissant.

Eclipse

La plupart des développeurs utilisent pour travailler sur GenJ l'IDE Eclipse.[2]

Il vous faut le télécharger, et l'installer sur votre ordinateur. Bien sûr choisissez la version qui correspond à votre système d'exploitation.

Mise en oeuvre du code dans Eclipse


Eclipse et propriétés à renseigner
Eclipse et propriétés à renseigner

Comment faire pour configurer "le new CVS repository"? Que met-on dans "host", "repository path", "user", "password", "connection type", "use defaultport (ou use port)" pour se connecter à GenJ?

Dans user, il faut mettre le login sur Sourceforge. Si l'on en a pas, peut-être que "anonymous" devrait faire l'affaire, mais il faut mieux obtenir un login.

Voilà ci-contre une capture d'écran des "Properties for GenJ".


La liste de discussion française de développement

La liste en elle-même

Vous connaissez GenJ, vous voulez participer à son développement en écrivant du code, en modifiant le code du programme.

Il vous suffit pour cela de vous abonner à la liste de discussion dédiée à cela.

  • Procédure d'Abonnement :

Il vous suffit pour cela de rejoindre le forum de discussion en envoyant un simple message à l'intention de : "genj_dev-subscribe@ml.arvernes.com". Ne mettez rien dans le corps du message, mais dans la ligne du "sujet" mettez uniquement le mot subscribe et c'est tout.

N.B.   (Vous pouvez aussi si vous le souhaitez cliquer sur le nom du destinataire ci-dessous, cela ouvrira automatiquement votre logiciel de courrier et mettra le mot requis dans la ligne "sujet". Vous n'aurez qu'à l'envoyer) : genj_dev-subscribe@ml.arvernes.com


  • Procédure de Désabonnement :

Pour vous désabonner de la liste, il suffit de faire un message à l'intention de "genj_dev-unsubscribe@ml.arvernes.com" et mettre le mot unsubscribe dans la ligne du sujet. Ou alors cliquez sur l'adresse ci-contre : genj_dev-unsubscribe@ml.arvernes.com

Et envoyez le message qui va être généré.


  • Pour envoyer un message à l'Administrateur de la liste :

Il suffit de faire un message à l'intention de : genj_dev-owner@ml.arvernes.com


  • Gestionnaire de la liste :

La personne en charge de cette liste est Daniel ANDRÉ.


Les archives de la liste

N'oubliez pas que vous pouvez toujours consulter les archives de la liste de discussion ici.[3]


Site de suivi français

Il existe en plus du tracker de sourceforge (tracker officiel) géré par Nils Meier, un équivalent français, géré par Daniel André sur le site bugs.arvernes.com.

En visitant ce dernier site, vous verrez les différentes demandes qui ont été faites, les développements en cours sur certaines d'entre elles. Promenez-vous dans les pages du site, et vous comprendrez trés facilement comment tout cela fonctionne.

Cependant pour comprendre la différence entre le tracker de Sourceforge et le site bugs sur Arvernes, on pourrait dire que Sourceforge gère le source de GenJ, alors que bugs gère plus les rapports et développements faits du côté français.


Notes

  1. Plusieurs liens peuvent être trouvés pour avoir des informations sur CVS, néammoins, le site anglais non gnu CVS est un lieu indispensable à consulter.
  2. Un lien sur Wikipedia vous donnera quelques informations, si vous ne connaissez pas Eclipse.
  3. Elles sont répertoriées depuis le 11 janvier 2008.
Sunclock Xrmap