FAQ Développeur
Récupérer/mettre à jour la version CVS développeur
Utilisation du CVS
La première opération consiste à récupérer les dernières versions des sources CVS. Pour cela, voir la Version CVS du jour. Les nouveaux fichiers doivent écraser les anciens.
Pour récupérer la dernière version CVS, vous pouvez aussi directement utiliser le serveur CVS en mode anonyme, si vous disposez d'un client CVS (commande cvs sous linux, ou TortoiseCVS par exemple sous windows) La commande script permettant de récupérer un snapshot intégral (sans suivi cvs) dans le répertoire courrant est:
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr export CVSROOT cvs -q export -r HEAD -d ./ dolibarr/
Pour récupérer uniquement les 3 dossiers principaux de Dolibarr:
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr export CVSROOT cvs -q export -r HEAD -d ./htdocs dolibarr/htdocs cvs -q export -r HEAD -d ./mysql dolibarr/mysql cvs -q export -r HEAD -d ./external-libs dolibarr/external-libs
La commande permettant de mettre à jour localement la copie de travail CVS : Sous linux (script shell):
CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr export CVSROOT cvs -q update -P -d
Sous Windows avec Tortoise cvs
"C:\Program Files\CVSNT\cvs.exe" -q update -P -d CVSROOT=:pserver:anonymous@cvs.savannah.nongnu.org:/sources/dolibarr
Mise a jour de la base
La deuxième étape consiste à migrer la base. Pour celà, il suffit d'appeler la page http://maracinedolibarr/install/ et choisir l'option "Mise à jour".
Cette procédure de migration/mise à jour est conçue pour fonctionner quel que soit l'état de départ et peut être repassée plusieurs fois sans risque.
Démarrer le développement
Consulter intégralement la Documentation Développeur pour assimiler toutes les règles et principes imposées aux développeurs. Vous pouvez aussi consulter les FAQ suivantes.
Comment créer un nouveau theme
Voir pour cela la page Themes
Voir pour cela la page Système_de_menus
Comment développer mon propre module
Voir pour cela la page Developpement_module
Comment ajouter une traduction
Voir pour cela la page Documentation_traducteur
Changer mon système de numérotation des factures en cours de route
Si le nouveau système de numérotation n'entre pas en conflit avec l'ancien, il suffit d'aller dans le menu Configuration - Modules - Configuration factures et prendre un nouveau modèle dans la liste. Si le nouveau système rentre en conflit, il est nécessaire de renuméroter vos références existantes. Cela peut-être fait avec une requête SQL. Par exemple, pour passer de Jupiter (FYYYYMM99) à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:
update llx_facture set facnumber=concat('FA',substr(facnumber,4,4),'-',substr(facnumber,8))
where facnumber like 'F%' and facnumber not like 'FA%';
Par exemple, pour passer d'un modele FAYYMM999 à Terre (FAYYMM-999), vous pouvez exécuter la requête suivante:
update llx_facture set facnumber=concat('FA',substr(facnumber,3,4),'-',substr(CONCAT('0000',substr(facnumber,7)),-4))
where facnumber like 'FA%' and facnumber not like '%-%';
Soumettre un patch, amelioration ou participer au développement
- Avec accès CVS en écriture
A ce jour, les accès en écriture au CVS sont restreints (le nombre de commit étant déjà suffisamment dynamique). Il n'est pas exclu d'accueillir d'autres développeurs en modification à d'autres horizons. Si vous bénéficiez donc à l'heure actuelle d'un accès CVS en écriture, utilisez-le. Sinon, il est nécessaire de suivre la procédure qui suit (Modification du code, sans accès CVS en écriture)
- Sans accès CVS en écriture
Si vous n'avez pas de compte développeur, il est nécessaire de fournir par mail, votre fichier patch.
Sous tout OS:
Voici la méthode Pro selon laquelle travailler pour pouvoir générer un tel fichier patch:
- Avoir un répertoire qui contient la version de Dolibarr de référence (résultat de la mise à jour CVS ou bien tout simplement l'arborescence résultant de la décompression d'un snapshot tgz de Dolibarr). On appellera ce répertoire ancien_rep. Vous pouvez récupérer le snapshot de la version de dev en cours sur le site officiel de Dolibarr.
- Avoir un autre répertoire qui contient l'arborescence de Dolibarr mais dans laquelle vous faites ou avez fait vos modifications. On appellera ce répertoire nouveau_rep.
Pour générer le fichier patch, il suffit alors de lancer la commande diff (en standard sous Linux, fourni dans cygwin sous Windows) de la manière suivante:
diff -Naur --exclude=CVS --exclude=".#*" --exclude="*~" --exclude="*.bak" --exclude=conf.php --exclude=documents ancien_rep nouveau_rep > fichier.patch
Envoyer votre patch sur la ML. L'intégration de votre patch n'est toutefois pas garantie, pas plus que le délai.
Sous Windows:
Si vous êtes sous Windows, une méthode moins Pro mais qui donne le même résultat est la suivante. Installer l'excellent outil open source de comparaison Winmerge qui sait fabriquer des patchs au format diff -Naur. Pour cela, comparer avec Winmerge le fichier référence et le fichier modifié et choisir dans le menu "Tools - Generate patch" (Générer des retouches en version française). Saisir un nom de fichier comme "resultat.patch", cocher la case "Append" et choisir l'option "Format Unified" (Style : unifié en version française). Cliquer sur "Ok". Éventuellement recommencer pour chaque fichier modifié. Au final, on obtient un beau fichier resultat.patch qui contient toutes les modifications au bon format.
Au lieu de rechercher manuellement vos fichiers, si vous avez installé conjointement TortoiseCVS et Winmerge, vous pouvez vous contenter de votre version modifiée sur votre ordinateur, et de la version CVS en ligne. Sous l'explorateur Windows, faites un clic droit sur le fichier qui doit être patché, et choisissez "CVS comparer" (pas WinMerge qui se trouve quelques lignes plus bas). Tortoise va lui-même lancer WinMerge. Puis reprenez la procédure décrite ci-dessus.
Appliquer un patch Si votre patch n'a pas encore été appliqué, mais que vous souhaitez de votre coté l'appliquer sur votre serveur linux fraichement mis à jour depuis la CVS, cela est possible grace à l'utilitaire patch. En admettant que vous avez créé votre patch à partir du répertoire htdocs de votre copie locale du cvs modifiée par vos soins, et que vous avez envoyé votre patch (monfichier.patch) sur le serveur dans le dossier patchs situé au meme niveau que votre dossier htdocs distant, la commande suivante devrait faire l'affaire (executée depuis le dossier patchs):
patch -u -p0 -d ../htdocs < monfichier.patch
Pour information: -p0 permet d'utiliser le chemin entier tel que mentionné dans le fichier de patch (-pn en retire les n premiers niveau de l'arborescence) -d permet de préciser le chemin relatif vers le dossier htdocs à patcher. < permet de donner le chemin vers le fichier source à utiliser (le patch en mode unifié) -u permet de préciser que le patch est en mode unifié
Comment devenir développeur officiel
Ceci passe par plusieurs étapes.
Membre de l'alliance
Il faut d'abord se familiariser avec les règles et normes de développements. En lisant toute la documentation développeur, vous devenez ainsi membre de l'alliance.
Chasseur de l'alliance
L'étape suivante consiste à soumettre des patch, en commençant par des simples, sur la ML (voir chapitre précédent). A votre première soumission, vous entrez alors dans la famille des Chasseurs de l'alliance.
Jedi
Ce n'est qu'au bout d'un temps variable, qui peut être très long, et si la qualité des patch qui ont été envoyée est satisfaisante que l'équipe en place offrira un accès CVS direct. Vous êtes devenu un Jedi. Ce titre ne se demande pas, il s'obtient par proposition d'un autre Jedi. Ce privilège est toutefois exceptionnel. La qualité de Dolibarr ne pouvant être atteindre que par un nombre de commiteur très réduit, ce qui n'empêche pas d'avoir un nombre de développeur (chasseurs) très important (grâce au système de patch).
Maitre Yoda
Au nombre de 1 à 3, c'est le role de chef de projet.