Lionel Meister 2 Décembre 2005

Transcription

1 Génie logiciel au laboratoire Lionel Meister IUSTI UMR Décembre 2005

2 Contenu de l exposé Quels outils disponibles? Principe Les gestionnaires de version existants Mise en oeuvre avec Subversion Documentation Enjeux et problèmes Solutions existantes Mise en oeuvre Conclusion

3 Quels outils disponibles? Plan de l exposé Quels outils disponibles? Principe Les gestionnaires de version existants Mise en oeuvre avec Subversion Documentation Enjeux et problèmes Solutions existantes Mise en oeuvre Conclusion

4 Quels outils disponibles? Quels outils disponibles? faciliter la tâche de développement assister/permettre le développement simultané en équipe Outils de documentation faciliter la tâche de documentation maintenir la documentation à jour permettre différents niveaux de documentation (développeur, utilisateur, etc.)

5 Quels outils disponibles? Quels outils disponibles? faciliter la tâche de développement assister/permettre le développement simultané en équipe Outils de documentation faciliter la tâche de documentation maintenir la documentation à jour permettre différents niveaux de documentation (développeur, utilisateur, etc.)

6 Plan de l exposé Quels outils disponibles? Principe Les gestionnaires de version existants Mise en oeuvre avec Subversion Documentation Enjeux et problèmes Solutions existantes Mise en oeuvre Conclusion

7 Principe Système client serveur Dépôt écriture lecture lecture Client Client Client Fonctionnement le dépôt contient l ensemble du code source d un projet les développeurs peuvent récuperer le contenu du dépôt les développeurs peuvent modifier les fichiers du projet les modifications sont enregistrées dans le dépôt sans perte des versions précédentes (basé sur diff)

8 Principe Le problème à éviter 1 - récupération des fichiers Dépôt A 2 - modification des fichiers Dépôt A lecture lecture A A A A Client 1 Client 2 Client 1 Client publication de A Dépôt A 4 - publication de A Dépôt A écriture écriture A A Client 1 Client 2 A A Client 1 Client 2

9 Principe Fonctionnement des gestionnaires modernes 1 - récupération des fichiers 2 - modification des fichiers 3 - publication de A 4 - erreur out of date Dépôt Dépôt Dépôt Dépôt A A A A lecture lecture écriture écriture A A A A A A A A Client 1 Client 2 Client 1 Client 2 Client 1 Client 2 Client 1 Client A est comparé à A Dépôt 6 - création de la version hybride Dépôt 7- publication de la version hybride Dépôt 8 - tout le monde a accès à A* Dépôt A A A* A* lecture écriture lecture A A A A* A A* A A* A* Client 1 Client 2 Client 1 Client 2 Client 1 Client 2 Client 1 Client 2

10 Principe Possibilités offertes Fonctionnalités aucune perte dans la chronologie des développements développement multi-utilisateurs rendu possible recherche chronologique multi-critères (auteur, date, message, etc.) consultation de l évolution chronologique d un fichier avec dates de modifications, type d ajouts, auteur, etc. branchements pour différentes versions de code avec tronc commun Conséquences développements durables et sûrs sécurité pour les sauvegardes développeurs heureux!

11 Principe Possibilités offertes Fonctionnalités aucune perte dans la chronologie des développements développement multi-utilisateurs rendu possible recherche chronologique multi-critères (auteur, date, message, etc.) consultation de l évolution chronologique d un fichier avec dates de modifications, type d ajouts, auteur, etc. branchements pour différentes versions de code avec tronc commun Conséquences développements durables et sûrs sécurité pour les sauvegardes développeurs heureux!

12 Les gestionnaires de version existants CVS ( Avantages très répandu nombreuses interfaces graphiques existantes Inconvénients incrémente le numéro de version de l ensemble du projet gestion pénible des ajouts/suppressions de fichiers/répertoires

13 Les gestionnaires de version existants CVS ( Avantages très répandu nombreuses interfaces graphiques existantes Inconvénients incrémente le numéro de version de l ensemble du projet gestion pénible des ajouts/suppressions de fichiers/répertoires

14 Les gestionnaires de version existants Subversion ( Avantages comble les manques liés à l utilisation de CVS incrémentation du numéro de version par fichier gestion facile des ajouts/suppressions de fichiers/répertoires utilisation possible de Apache pour le serveur gestion des fichiers binaires Inconvénients moins répandu que CVS interfaces graphiques moins nombreuses

15 Les gestionnaires de version existants Subversion ( Avantages comble les manques liés à l utilisation de CVS incrémentation du numéro de version par fichier gestion facile des ajouts/suppressions de fichiers/répertoires utilisation possible de Apache pour le serveur gestion des fichiers binaires Inconvénients moins répandu que CVS interfaces graphiques moins nombreuses

16 Mise en oeuvre avec Subversion Chronologie d un projet sous Subversion Point de départ Administrateur 1. création d un dépôt et réglages de départ (nom des utilisateurs, autorisations, etc.) 2. ajout des sources dans le dépôt Cycle de travail Développeurs 1. mise à jour de sa copie : svn update 2. changements dans le code : édition du source, svn add, svn delete, svn copy, svn move 3. examen des changements par rapport au dépôt : svn status, svn diff, svn revert 4. merge des modifications du dépôt en cas de conflit : svn update, svn resolved 5. soumission des modifications au dépôt : svn commit

17 Mise en oeuvre avec Subversion Chronologie d un projet sous Subversion Point de départ Administrateur 1. création d un dépôt et réglages de départ (nom des utilisateurs, autorisations, etc.) 2. ajout des sources dans le dépôt Cycle de travail Développeurs 1. mise à jour de sa copie : svn update 2. changements dans le code : édition du source, svn add, svn delete, svn copy, svn move 3. examen des changements par rapport au dépôt : svn status, svn diff, svn revert 4. merge des modifications du dépôt en cas de conflit : svn update, svn resolved 5. soumission des modifications au dépôt : svn commit

18 Mise en oeuvre avec Subversion Chronologie d un projet sous Subversion / / / / / /A /A /A /A a a a a b b b b /B /B e e dossier fichier version 0 version 1 c c c f g version 2 d d

19 Documentation Plan de l exposé Quels outils disponibles? Principe Les gestionnaires de version existants Mise en oeuvre avec Subversion Documentation Enjeux et problèmes Solutions existantes Mise en oeuvre Conclusion

20 Documentation Enjeux et problèmes De la documentation? Pour quoi faire? Enjeux communiquer les développements (à un nouveau développeur ou entre les développeurs) pérenniser les développements faits par des gens qui ne sont plus là (thésard, post-doc, stagiaire) se rappeler le pourquoi et le comment Problèmes tendance à se focaliser sur le développement difficulté à voir que l investissement vaut le coup difficulté à mettre en place une documentation qui vaille le coup

21 Documentation Solutions existantes Solutions existantes Bricolage maison pas performant Commentaires dans le code source Docbook/XML Literate programming complexe, nouveau langage, contraignant CWEB et CWEB-like Mathematica Utilitaires puissants dédiés à la documentation limité à C/C++/Java Doxygen : dimitri/doxygen

22 Documentation Solutions existantes Solutions existantes Bricolage maison pas performant Commentaires dans le code source Docbook/XML Literate programming complexe, nouveau langage, contraignant CWEB et CWEB-like Mathematica Utilitaires puissants dédiés à la documentation limité à C/C++/Java Doxygen : dimitri/doxygen

23 Documentation Solutions existantes Solutions existantes Bricolage maison pas performant Commentaires dans le code source Docbook/XML Literate programming complexe, nouveau langage, contraignant CWEB et CWEB-like Mathematica Utilitaires puissants dédiés à la documentation limité à C/C++/Java Doxygen : dimitri/doxygen

24 Documentation Solutions existantes Solutions existantes Bricolage maison pas performant Commentaires dans le code source Docbook/XML Literate programming complexe, nouveau langage, contraignant CWEB et CWEB-like Mathematica Utilitaires puissants dédiés à la documentation limité à C/C++/Java Doxygen : dimitri/doxygen

25 Documentation Mise en oeuvre Principe de Robodoc Robodoc documentation dans l en-tête des fichiers source le source et la documentation sont synchronisés extraction de la documentation par Robodoc compilation classique documentation ROBODOC source COMPILATEUR exécutable

26 Documentation Mise en oeuvre Possibilités Entrée/sortie fonctionne avec tout langage permettant les commentaires (Fortran, C, C++, Perl, scripts shell, etc.) extraction de la documentation en HTML, XML DocBook, ASCII, LaTeX, PDF ou RTF Structuration classification/hiérarchisation possible des fichiers : fonctions, classes, méthodes, etc. tout est personnalisable et automatisable

27 Documentation Mise en oeuvre Exemple d en tête!***** reading/lecfich! NAME! lecfich! SYNOPSIS! subroutine lecfich(namer)! AUTHOR! D. Legendre! CREATION DATE! 08/01/2004! DESCRIPTION! Lecture du fichier jcl ou sont decrits les fichiers d entree et de! sortie! MODIFICATION HISTORY! A. PEDRONO, remplissage entete, 25/01/04! PARENTS! main, test! ARGUMENTS! namer : calcul name! SOURCE subroutine lecfich(namer) c===================================================================== c===================================================================== character*1 vide1 character*3 type,vide3 character*73 ligne!***... character namer*14 open(60,file= jcl,status= old ) do i=1,3

28 Documentation Mise en oeuvre Rendu HTML index des fichiers exemple d un fichier Index 318/11/Monday 16h03./doc/calc_xnu_f90.html 318/11/Monday 16h06 Generated from./src/ with ROBODoc v on Thu Jul 21 16:23: [Sourcefiles] [Index] [Generics] Index acceler acceler.f90 bilan bilan.f90 calc_vmas.f90 calc_xnu calc_xnu.f90 calcdiv calcdiv.f90 calcdudx calcdudx.f90 calcdudy calcdudy.f90 calcdudz calcdudz.f90 calcdufdt calcdufdt.f90 calcdvdx calcdvdx.f90 calcdvdy calcdvdy.f90 calcdvdz calcdvdz.f90 calcdvfdt calcdvfdt.f90 calcdwdx calcdwdx.f90 calcdwdy calcdwdy.f90 calcdwdz calcdwdz.f90 calcdwfdt calcdwfdt.f90 calclim_xnu calclim_xnu.f90 calclimphi_les calclimphi_les.f90 calcnu calcnu.f90 calcpar calcpar.f90 calcpfou calcpfou.f90 calcro calcro.f90 calcrop calcrop.f90 calcsij calcsij.f90 calcsj calcsj.f90 calcsjro calcsjro.f90 calct calct.f90 calctp calctp.f90 calcu calcu.f90 calcugr calcugr.f90 calcugrx calcugrx.f90 calcugry calcugry.f90 calcugrz calcugrz.f90 calcuuuf calcuuuf.f90 calcuvp.f90 calcv calcv.f90 calcvmas calcvort calcvort.f90 calcvvvf calcvvvf.f90 calcw calcw.f90 calcwwwf calcwwwf.f90 cdb cdb.f90 cds cds.f90 champv champv.f90 check_parameters.f90 cls cls.f90 clw clw.f90 coeffdbl coeffdbl.f90 coefffou coefffou.f90 coeffro coeffro.f90 coefft coefft.f90 coefftest coefftest.f90 coeffu coeffu.f90 coeffv coeffv.f90 coeffw coeffw.f90 correct correct.f90 cpartro cpartro.f90 cpartt cpartt.f90 cpartuvw cpartuvw.f90 dtdopt dtdopt.f90 dtopt dtopt.f90 dttraj dttraj.f90 ecrcnv ecrcnv.f90 filtredbl filtredbl.f90 filtretest filtretest.f90 fjedef fjedef.f90 fjerot fjerot.f90 forest.log four1 four1.f90 front front.f90 geo geo.f90 geoaivo geoaivo.f90 geobord geobord.f90 geodxdy geodxdy.f90 geogeop geogeop.f90 geoh2d geoh2d.f90 geoh3d geoh3d.f90 geohh3d geohh3d.f90 geoint geoint.f90 ijkposition ijkposition.f90 inifi inifi.f90 inifi_ro inifi_ro.f90 inifi_ro_1 inifi_ro_1.f90 inifi_ro_2.f90 inifi_ro_6.f90 inifi_ro_99.f90 inifigravite inifigravite.f90 inifipression1 inifipression1.f90 inifit_ro_6 inifit_ro_6 inifit_ro_99 init1 init1.f90 initalcuve initalcuve.f90 initcuve initcuve.f90 initpart initpart.f90 inituf inituf.f90 interp_ro.f90 interpt interpt interpt.f90 interpu interpu.f90 interpv interpv.f90 interpw interpw.f90 invers invers.f90 isocs Generated from./src/calc_xnu.f90 with ROBODoc v on Thu Jul 21 16:23: JADIM_VOF/calc_xnu NAME calc_xnu SYNOPSIS subroutine calc_xnu(ros) AUTHOR Y. Hallez CREATION DATE 23/02/2005 DESCRIPTION Physical properties computation (viscosity) inside the domaine PARENTS nslimain ARGUMENTS real (kind=8) ros(1:nx,1:ny,1:nz) : phase 2 volume fraction SOURCE subroutine calc_xnu!!=================! DECLARATIONS!================= use mod_nslcom3d!!.. Implicit Declarations.. implicit none!!.. Include Statements..!!=================! DECLARATIONS!=================!!.. Formal Arguments..!!.. Local Scalars.. integer :: i,j,k real (kind=8) :: g,p0!!... Executable Statements...!!! End of Declarations

29 Conclusion Plan de l exposé Quels outils disponibles? Principe Les gestionnaires de version existants Mise en oeuvre avec Subversion Documentation Enjeux et problèmes Solutions existantes Mise en oeuvre Conclusion

30 Conclusion Conclusion Subversion possibilité de développer à plusieurs (2 ) historique complet des évolutions maintenir/pérenniser un code de calcul diffusion sécurisée et centralisée du code Documentation Robodoc mise en place facile personnalisable/adaptable suffisamment simple pour être suivi par les développeurs suffisamment élaboré pour donner une documentation exploitable

31 Conclusion Conclusion Subversion possibilité de développer à plusieurs (2 ) historique complet des évolutions maintenir/pérenniser un code de calcul diffusion sécurisée et centralisée du code Documentation Robodoc mise en place facile personnalisable/adaptable suffisamment simple pour être suivi par les développeurs suffisamment élaboré pour donner une documentation exploitable

32 Conclusion Stratégie de mise en oeuvre Point de départ mise en place, géré par le gestionnaire de versions : du code source documenté de cas test permettant la validation du code Développement quotidien utilisation du gestionnaire de versions avant soumission des modifications locales, un développeur : doit avoir documenté ce qu il a fait doit passer l ensemble des cas test avec succès mise en place d un script qui génère la documentation en ligne à chaque fois qu un développeur rajoute des modifications

33 Conclusion Stratégie de mise en oeuvre Point de départ mise en place, géré par le gestionnaire de versions : du code source documenté de cas test permettant la validation du code Développement quotidien utilisation du gestionnaire de versions avant soumission des modifications locales, un développeur : doit avoir documenté ce qu il a fait doit passer l ensemble des cas test avec succès mise en place d un script qui génère la documentation en ligne à chaque fois qu un développeur rajoute des modifications

34 Conclusion Liens internet Gestionnaires de versions Subversion : CVS : comparaison : Outils de documentation Robodoc : rfsber/robo/robodoc.html Doxygen : dimitri/doxygen literate programming :

35 Conclusion Connexions possibles avec Subversion Introduction On one end is a Subversion repository that holds all of your versioned data. On the other end is your Subversion client program, which manages local reflections of portions of that versioned data (called working copies ). Between these extremes are multiple routes through various Repository Access (RA) layers. Some of these routes go