aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorherbelin2005-08-01 13:05:54 +0000
committerherbelin2005-08-01 13:05:54 +0000
commit0448334373532d459a0bafd3e92aa0629d730297 (patch)
treef1297f760724e1dfcdd47a96b8268fe98b4b6759
parentf9acde8c9cd97a5270013b8a4d48a5c2e75b15c1 (diff)
Procédure d'ajout d'une nouvelle contributions utilisateur
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/coq/trunk@7261 85f007b7-540e-0410-9357-904b9bb8a0f7
-rw-r--r--distrib/NEWCONTRIB.howto84
1 files changed, 84 insertions, 0 deletions
diff --git a/distrib/NEWCONTRIB.howto b/distrib/NEWCONTRIB.howto
new file mode 100644
index 0000000000..09b1ec64e3
--- /dev/null
+++ b/distrib/NEWCONTRIB.howto
@@ -0,0 +1,84 @@
+ Procédure d'ajout d'une nouvelle contribution Coq
+ -------------------------------------------------
+
+A) Dans l'archive des contributions nouvelle syntaxe ("constr/contrib8",
+ aliasé à "contrib" dans l'archive pauillac:/net/pauillac/constr/ARCHIVE).
+
+1) Si la contribution provient d'une institution qui n'a pas encore
+ contribué, créer un répertoire du nom de l'institution.
+
+2) Dans le répertoire associé à l'institution, créer un répertoire du nom de
+ la contribution. S'assurer que le nom est significatif.
+
+3) Placer la contribution soumise dans ce répertoire et vérifier
+ qu'elle compile avec la version bugfix de la version de Coq
+ actuellement distribuée (ci-dessous appelée version X.XX).
+
+4) S'assurer que les fichiers Make et Makefile existent et sont dans
+ le format standard de coq_makefile, et récursivement dans les
+ sous-répertoires. Sinon, standardiser Make et Makefile et vérifier
+ que cela continue de compiler.
+
+5) Ajouter le nouveau répertoire du Make se trouvant dans le
+ répertoire de l'institution et reconstruire le Makefile associé.
+
+6) Si l'institution est nouvelle, ajouté son nom au Make et au
+ Makefile principal de l'archive contrib (attention, Makefile n'est
+ pas auto-engendré, c'est Makefile.sites qui l'est).
+
+7) Vérifier que l'auteur de la contribution a soumis un fichier
+ description et que les champs sont correctement nommés. Vérifier
+ l'orthographe, etc. S'assurer que le fichier description est à la
+ racine du répertoire associé à la contribution. Vérifier que
+ l'identifiant "Name" (ci-dessous appelé CONTRIBNAME) associé à la
+ contribution est significatif et pas déjà pris par une autre
+ contribution.
+
+8) Si la contribution a un fichier jouant le rôle d'un README,
+ s'assurer qu'il s'appelle bien README quitte à le renommer (par
+ exemple "readme" doit être renommé).
+
+9) Commiter l'ajout du ou des nouveaux répertoires et fichiers, ainsi
+ que la modification des différents Make et Makefile (et éventuellement
+ Makefile.sites).
+
+10) Si la contribution compile bien, on peut déplacer le tag associé à
+ la version actuellement distribuée vers les nouveaux fichiers et
+ répertoires.
+
+
+B) Sur la section contributions du site web de Coq (module www sur
+ pauillac.inria.fr:/net/pauillac/constr/ARCHIVE, sous-répertoire
+ coq/contribs)
+
+1) Déterminer la ou les catégories et sous-catégories dans laquelle
+ classer la nouvelle contribution. Le cas échéant, ajouter une
+ nouvelle sous-catégorie.
+
+2) Dans le ou les fichiers .prehtml associés à cette ou ces
+ catégories, ajouter un item bilingue avec le nom de la
+ contribution, son identifiant, et les auteurs.
+
+3) Faire "make" dans le répertoire www/coq/contribs après avoir
+ configurer ../config avec le tag de la version courante de Coq et
+ s'être assuré que contrib-X.XX était effacé.
+
+4) Faire une mise à jour partielle du site web de coq:
+
+ export MACHINE=pauillac.inria.fr
+ export WEB=/net/pauillac/infosystems/www/coq/contribs
+ export FTP=/net/pauillac/infosystems/ftp/coq/coq/current
+ scp all-contribs/CONTRIBNAME.{tar.gz,html,description}\
+ all-contribs/search.db all-contribs/summary.html *.html $MACHINE:$WEB
+ ssh $MACHINE chmod -f g+w $WEB/*
+ scp contrib-X.XX.tar.gz $MACHINE:$FTP
+ ssh $MACHINE chmod -f g+w $FTP/contrib-X.XX.tar.gz
+
+5) S'assurer que le site web de coq a été mis à jour correctement, que
+ la nouvelle contribution apparaît dans les versions anglaise et
+ française du classement thématique, ainsi que dans la liste
+ complète. Vérifier que l'outil de recherche par mot-clé la trouve.
+
+6) Commiter les modifications faites à l'archive www/coq/contribs
+
+7) Confirmer à l'auteur l'installation de sa contribution