Quelques conseils pour les nouvelles recrues

Quelques conseils pour les nouvelles recrues

Romain Pacanowski


Informations utiles

Les développeurs sont joignables à l'adresse suivante :

Les deux mailing lists d'Opale sont :

Les archives de ces mailing lists sont disponibles aux adresses suivantes :

Il existe également d'autres listes :

  1. pour recevoir les logs lors de commits sur le repository de la librairie
  2. pour le développement du site web :
  3. pour recevoir les logs lors de commits sur le repository du site web :
La liste des abonnées à ces listes sont accessibles sur le site de tuxfamily : après s'être connecté sur son compte, il suffit d'aller sur la page du projet Opale, puis dans la rubrique "mailing list" (sur la panneau de gauche) choisir une des listes. Le panneau d'administration de la liste s'affichera alors et il est possible sur ce dernier d'accéder à la liste des abonnées.

Préparatifs I

Si ce n'est pas encore fait, téléchargez un kit de développement Java (JDK) sur le site de Sun par exemple. Munissez-vous aussi d'un éditeur minimal comme vi, nedit, emacs ou que sais-je !!!

N'oubliez pas de vous inscrire sur Savannah et sur Tuxfamily et de contacter les administrateurs pour qu'ils vous ajoutent au projet.

Opale Current Release

Afin de vous familiariser avec Opale le plus simple est de télécharger la dernière version d'Opale qui est disponible dans la rubrique download .

Décompressez là puis lisez la documentation contenue dedans. Essayez de faire un petit programme comme celui ci-dessous utilisant Opale quelque part sur votre disque dur et de le compiler et de l'éxécuter.

import opale.m2d.*; 
		
public class TestOpale {
 	public static void main(String args[]) {
  	OIJ repere = new OIJ();
  	Point2D p1 = new Point2D(repere,1,2); 
  	System.out.println(p1); 
 	} 
}
		

La sortie du programme ci-dessus devrait ressembler, pour ce qui est des trois dernières lignes, à ça :

New OpaleObject : opale.m2d.OIJ New OpaleObject : opale.m2d.OIJ New OpaleObject : opale.m2d.Point2D (1.0; 2.0)

Si cela ne marche pas c'est que vous avez, certainement, mal positionné les variables d'environnement !!

Essayez aussi d'utiliser les scripts disponibles sur votre plate-forme qui sont dans le répertoire utils. Générez l'API par exemple.

Préparatifs II

Afin de pouvoir développer au sein du projet Opale il vous faut plusieurs outils dont :

  1. SSH : disponible sur www.openssh.org. Les utilisateurs de Windows peuvent télécharger PuTTy , un client ssh, ici

    D'autres préferont peut-être, à raison, installer un environnement Unix minimal comme Cygwin ou MinSys

  2. CVS dont les binaires sont disponibles ici
  3. ANT
  4. extension pour ANT : Netcomponents.jar (seulement pour les développeursqui souhaitent mettre à jour le site eux-mêmes)

Installez tous ces "logiciels" et vérifiez que tout fonctionne bien. Les développeurs du site web voudront certainement aussi installer les "logiciels" suivants :

  1. Apache : disponible sur www.apache.org
  2. MySQL : disponible sur www.mysql.org ou www.mysql.com
  3. PHP4 : disponible sur http://www.php.net

Les personnes sous Windows pourront aussi se tourner vers les logiciels suivants :

  1. EasyPHP : un installateur automatique d'Apache MySQL PHP4
  2. WinCVS un front end pour CVS très agréable
  3. TortoiseCVS qui est un logiciel qui se greffe dans l'explorateur de fichiers de Windows

Opale CVSTREE

Deuxième étape, de notre parcours initiatique,récupérez les sources d'Opale. Bien que l'archive au format d'Opale contienne les sources, dans cette partie on s'intéresse à la récupération des sources via CVS.

Pour rapatrier les sources via CVS vous pouvez dans un premier temps utilier un accès anonyme et les récupérer en tapant :

  1. cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/opale login
  2. tapez sur la touche enter
  3. cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/opale co Opale

Avertissement

Cette méthode ne vous donne pas d'accès en écriture au "repository". Pour avoir un acès en écriture, il faut utiliser l'accès sécurisé avec SSH (voir prochaine section pour le détail) et y avoir été autorisé par un administrateur d'Opale.

Une fois les sources rapatriées essayer de compiler Opale en tapant tout simplement ant dans le répertoire Opale qui vient d'être créé par CVS lors du rappatriement ds sources. Lisez pour plus d'infos le chapitre sur ANT et le fichier Opale/build.xml.

Un petit HOW-TO sur CVS, SSH et Opale

Voici quelques indications pour vous guider dans l'utilisation de CVS dans le but de récuperer et travailler sur le CVSTREE d'Opale

Sous Windows

Note

Cette section est devenue obsolète puisque le ssh de NetWorkSimplicity n'est plus maintenu. Nous conseillons aux Windowsiens l'utilisation de MinGW ou de Cygwin. La documentation UNIX s'appliquant parfaitement à ces deux environnements.

Sous UNIX

Pour pouvoir utiliser CVS sur Savannah, il faut générer une clé ssh à l'aide de l'utilitaire ssh-keygen . Pour ce faire, tapez dans un xterm ou en mode console : ssh-keygen -t dsa . Entrez pour plus de sécurité une ``passphrase''. Par défaut cela va créer dans un répertoire (par defaut ~/.ssh/) un fichier id_dsa.pub. Enfin n'oubliez pas que la variable CVS_RSH doit valoir ssh. (export CVS_RSH=ssh)

Dans ce même répertoire, mettez dans le fichier config (s'il n'existe pas créez le) les lignes suivantes :

Host *.gnu.org Protocol 2 Host *.fsf.org Protocol 2

Ensuite rdv sur le site de savannah, logguez vous et allez dans la partie "Account maintenance" (lien qui se situe sur la barre de menus verticale dans le premier groupe). En bas de cette page se trouve un paragraphe nommé "Shell account information " cliquez sur le lien "Edit Keys" et entrez dans le champ "Authorized keys" le contenu du fichier identity.pub. Cliquez ensuite sur "Update" et vérifier sur la page "Account maintenance" que le nombre de clé entrées est bien le nombre de clé que vous avez soumis (à ce stade cela doit être 1 si vous êtes un nouveau membre de savannah et que c'est la première clé que vous enregistrez).

Rappatriement des sources de la librairie.  Placez vous dans le répertoire dans lequel vous voulez rappatrier les sources. Cette opération créera le répertoire Opale à l'endroit où vous l'effectuez. Voici les instructions :

  1. cd OU_VOUS_VOULEZ
  2. Sous UNIX : export CVSROOT=VOTRE_LOGIN_SUR_SAVANNAH@cvs.tuxfamily.org:/cvsroot/opale
  3. Sous Windows (en commandes MS-DOS uniquement): set CVSROOT=VOTRE_LOGIN_SUR_SAVANNAH@cvs.tuxfamily.org:/cvsroot/opale
  4. cvs co Opale
Le rappatriement des sources devraient alors débuter après que vous ayez entré votre mot de passe qui protège votre clé privée. Cette opération ne peut marcher que si, vous avez mis sur savannah votre clé publique. Un délai de quelques heures est à prevoir entre le moment où vous uploader votre clé publique et sa prise en compte par le serveur.

Rappatriement des sources des applications.  Placez vous dans le répertoire dans lequel vous voulez rappatrier les sources. Cette opération créera le répertoire OApplications à l'endroit où vous l'effectuez. Voici les instructions :

  1. cd OU_VOUS_VOULEZ
  2. Sous UNIX : export CVSROOT=VOTRE_LOGIN_SUR_SAVANNAH@cvs.tuxfamily.org:/cvsroot/opale
  3. Sous Windows (en commandes MS-DOS uniquement):set CVSROOT=VOTRE_LOGIN_SUR_SAVANNAH@cvs.tuxfamily.org:/cvsroot/opale
  4. cvs co OApplications

Rappatriement des sources du site web.  Placez vous dans le répertoire dans lequel vous voulez rappatrier les sources. Cette opération créera le répertoire Opale à l'endroit où vous l'effectuez. Voici les instructions :

  1. cd OU_VOUS_VOULEZ
  2. Sous UNIX : export CVSROOT=VOTRE_LOGIN_SUR_TUXFAMILY@cvs.tuxfamily.org:/cvsroot/web
  3. Sous Windows (en commandes MS-DOS uniquement): set CVSROOT=VOTRE_LOGIN_SUR_TUXFAMILY@cvs.tuxfamily.org:/cvsroot/web
  4. cvs co Opale-WebSite

Survie sous CVS

Je ne vais pas réinventer la roue. Il faut absolument, si vous ne connaissez pas CVS s'astreindre à la lecture d'une introduction au minimum. Ci-dessous quelques documentations intéressantes sur le sujet :

  1. Une introduction en français.
  2. Une super doc mais en anglais.
  3. Documentation pour les windowsiens

Voici néanmoins quelques commandes vitales, à connaître quand on débute sous CVS. Les commandes sont listées ci-dessous viennent à la suite de la commande générique cvs (donc tapez cvs commande)

  1. checkout ou co : permet de récuperer une copie locale de l'arborescence CVS du projet hébergée sur le serveur.
  2. update -d : met à jour votre arborescence locale avec l'arborescence du serveur. TOUJOURS commencez par faire ceci comment vous commencez à travailler SINON vous ne pourrez COMMITER ie reporter au serveur vos modifications
  3. ci un_fichier | liste_fichier: check in ie commit met à jour le fichier ou la liste de fichiers spécifié du serveur avec vos modifications locales
  4. add un_fichier | liste_fichier : ajoute un fichier ou une liste de fichiers à l'arborescence CVS du serveur. Il faut faire un commit (cvs ci) de ces mêmes fichiers pour valider leur ajout.
  5. remove un_fichier | liste_fichier : enlève un fichier ou une liste de fichier. Il faut au préalable enlever la copie locale puis faire le remove puis enfin commiter.

ANT

Une fois ANT récupéré et decompressé, il vous suffit, pour compléter l'installation, si ce n'est pas déjà fait, de positionner correctement les variables d'environnement suivantes :

  1. JAVA_HOME: qui doit contenir le répertoire d'installation du jdk.
  2. ANT_HOME : qui doit contenir le répertoire d'installation de ANT
  3. PATH : qui doit contenir le chemin de l'executable ant.bat (typiquement sous répertoire bin du répertoire d'installation de ANT).

Opale et son site web

Généralités

La page d'accueil du projet est : http://savannah.gnu.org/projects/opale/

Les sources CVS du projet sont visibles la http://savannah.gnu.org/cgi-bin/viewcvs/opale/Opale/

Les news : http://savannah.gnu.org/news/?group=opale

L'espace de téléchargement, qui contient a dernière version d'Opale, se situe sur : http://opale.tuxfamily.org/download/opale/ ainsi que sur http://freesoftware.fsf.org/download/opale/ qui contient également les anciennes versions d'Opale.

Organisation de l'espace de téléchargement sur Savannah :

Un répertoire :

  1. archives/ qui contient des vieux documents
  2. documentation/ qui contient les précédentes documentation
  3. opale/ qui contient les précédentes releases
et le répertoire courant contient principalement les fichiers :
  1. INSTALL_EN.txt
  2. INSTALL_FR.txt
  3. ChangeLog
  4. ChangeLog_FR
  5. README

Gestion de l'espace de téléchargement

Avec sftp justement en utilisant la ligne suivante : sftp -1 VOTRE_USERNAME_SUR_SAVANNAH@freesoftware.fsf.org:/opale/ c'est tout pour savannah.

Le site web d'Opale est hébergé sur tuxfamily.org.

Vous pouvez consulter les sources du site web à cette adresse

Pour rapatrier les sources du site web, il faut avoir un login sur tux et effectuer les opérations suivantes:

  1. export CVS_RSH=ssh
  2. export CVSROOT=VOTRE_USERNAME_SUR_TUXFAMILY@cvs.tuxfamily.org:/cvsroot/web
  3. cvs -d:ext:VOTRE_USERNAME_SUR_TUXFAMILY@cvs.tuxfamily.org:/cvsroot/web co Opale-WebSite


Opale Team : February 14 2004 19:17:37.






valid xhtml image