
                          Documentation de daCode
                           http://www.dacode.org
                               Janvier  2001

               Denis Barbier <barbier@imacs.polytechnique.fr>

   Introduction
   ============

   Ce document explique comment participer au développement de
   daCode. Outre ce document, les principales ressources pour
   trouver des réponses à vos questions sont le site web
   <URL:http://www.dacode.org/> et la liste de diffusion de daCode,
   archivée sur <URL:http://www.somelist.com/mail.php/230>.
   Pour s'abonner, envoyer un mail à <URL:mailto:sympa@linuxfr.org>
   avec dans le sujet « sub dacode-dev », par exemple en exécutant
     mail -s 'sub dacode-dev' sympa@linuxfr.org < /dev/null


   Comment participer
   ==================

   Quels que soient vos talents de développeur, vous pouvez aider à
   la mise au point de daCode. D'ailleurs, il n'est nul besoin d'être
   développeur, il y a plein de choses à faire comme écrire de la
   documentation, retoucher les images, traduire des documents, faire la
   chasse aux bugs, etc qui ne nécessitent aucune connaissance de PHP.
   Ce document ne traite que de la façon de participer au
   développement du code source, vous pouvez demander sur la liste de
   diffusion comment participer aux autres tâches.

   Télécharger les sources
   =======================

   La version stable actuelle est 1.2.0, téléchargeable à

     http://www.daCode.org/download.php3

   La version en cours de développement est disponible sur
   sourceforge.net avec CVS:

     cvs -d \
       :pserver:anonymous@cvs.dacode.sourceforge.net:/cvsroot/dacode \
       login

   (appuyez sur Enter à la demande du mot de passe)

     cvs -z3 -d \
       :pserver:anonymous@cvs.dacode.sourceforge.net:/cvsroot/dacode \
       checkout -P daCode

   Plus tard, lorsque vous voulez mettre à jour vos fichiers, il
   suffit d'aller dans le répertoire daCode et de taper
     cvs -z3 update -P -d

   Remarque : il est fastidieux de taper les mêmes options à chaque
           fois. Heureusement pour les fainéants, il existe une
           solution, qui consiste à placer les options qui sont
           toujours utilisées dans le fichier $HOME/.cvsrc ; ainsi,
           on peut y mettre les lignes suivantes :
              cvs -z3
              checkout -P
              update -P -d
              diff -u
           Une fois cette manoeuvre effectuée, toutes les commandes
           CVS se feront avec l'option -z3, les checkout avec -P,
           etc, rendant ces options sur la ligne de commande
           inutiles. Cependant, nous continuerons à les écrire dans
           ce document, par souci de clarté.

   Pour ceux n'ayant pas d'accès CVS, une archive est faite tous les
   matins à 6h, heure de Paris, et disponible à
      http://perso.linuxfr.org/penso/daCode.tar.gz

   Installation
   ============

   Lire la doc incluse dans daCode, et demander de l'aide sur la
   liste de diffusion en cas de problème.

   Faire des corrections
   =====================

   Seules quelques personnes sont habilitées à faire des
   modifications dans le source. Quand vous avec des corrections à
   proposer, il faut envoyer un patch sur la liste de diffusion (voir
   ci-dessous).  Dans la journée, un des développeurs habilités
   devrait répondre, en disant si le patch a été incorporé ou non, et
   dans ce dernier cas pourquoi.
   Si personne n'a répondu au bout de quelques jours, c'est que votre
   message a été lu puis oublié, donc n'hésitez pas à vous signaler à
   nouveau, si possible en fournissant un lien vers votre message
   archivé sur <URL:http://www.somelist.com/mail.php/230>.

     Création d'un patch avec accès CVS
     ----------------------------------

   C'est la solution la plus simple, pour tout le monde. Vous
   récupérez la version la plus récente du CVS de daCode, vous faites
   les changements dans le source, puis
        cvs diff -u > ~/dacode.patch
   Si vous ajoutez de nouveaux fichiers, il faut en plus les inclure dans le
   patch. Ce n'est pas faisable avec CVS à cause d'un bug, il faut
   donc le faire manuellement ; par exemple, pour ajouter le fichier
   src/htdocs/new.php3, tapez
        diff -u /dev/null src/htdocs/new.php3 >> ~/dacode.patch

     Création d'un patch sans accès CVS
     ----------------------------------

   Vous devez alors récupérer 
      http://perso.linuxfr.org/penso/daCode.tar.gz
   et le désarchiver. Il faut ensuite renommer le répertoire daCode en
   daCode.orig, puis désarchiver à nouveau, c'est-à-dire :

      wget http://perso.linuxfr.org/penso/daCode.tar.gz
      tar zxf daCode.tar.gz
      mv daCode daCode.orig
      tar zxf daCode.tar.gz

   Vous avez maintenant deux répertoires: daCode.orig qui contient
   les sources originales, à ne pas modifier, et dacode, qui est
   votre arborescence de travail.
   Après avoir fait les modifications sous ce répertoire, revenez
   dans le répertoire contenant daCode et daCode.orig, et lancez
   la commande
      diff -ur --exclude CVS daCode.orig daCode > ~/dacode.patch

   Si vous avez ajouté de nouveaux fichiers, vous pouvez procéder
   comme décrit dans la sous-section précédente, ou utiliser la
   commande
      diff -uNr --exclude CVS daCode.orig daCode > ~/dacode.patch

     Envoi du patch
     --------------

   Envoyez un message sur la liste de diffusion expliquant ce
   que fait votre patch, en mettant [PATCH] dans le sujet pour
   retrouver le message plus facilement, et en n'oubliant pas
   d'attacher le fichier ~/dacode.patch créé suivant une des
   procédures ci-dessus.

