modif de la documentation doc_procedure_verification.pdf : ajout d une section regroupant les referents du projet (personnes a contacter); ajout d une section expliquant comment actualiser le catalogue de tests catalogue_tests.pdf (avec procedure a suivre en cas d erreur)

Doc/doc_procedure_verification.tex

@@ -101,7 +101,6 @@ citecolor= green %couleur citation biblio
 
 \clearpage
 
-
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{Introduction {\small \it (Gérard Rio)}}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -116,8 +115,41 @@ Deux objectifs principaux sont recherch
 \end{itemize}
 
 Enfin l'idée est que rien n'est définitif, et que des évolutions sont prévisibles en fonction des demandes et attentes des utilisateurs.
-%
+
+
+
+
+
+
+
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Personnes référentes}\label{section_personnes_referentes}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+Liste des personnes référentes à contacter pour toute question/problème :
+\begin{itemize}
+\item[\textbullet] Gérard Rio (développeur \verb|Herezh++|)\\
+\hspace*{1cm} mail : {\color{blue} gerard.rio@univ-ubs.fr}
+\item[\textbullet] Julien Troufflard (développeur scripts procédure de vérification)\\
+\hspace*{1cm} mail : {\color{blue} troufflard@univ-ubs.fr}
+\end{itemize}
+
+
+
+
+
+
+
+
+
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{Arborescence du projet}\label{section_arborescence}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 L'arborescence du projet CVS est la suivante :\\
 
 \begin{tikzpicture}[%
@@ -135,6 +167,17 @@ L'arborescence du projet CVS est la suivante :\\
 
 
 
+
+
+
+
+
+
+
+
+
+
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{Lancement de la batterie de tests}\label{section_lancement_batterie_tests}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -197,6 +240,16 @@ Exemples d'options :
 \end{itemize}
 
 
+
+
+
+
+
+
+
+
+
+
 %%
 \clearpage
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -378,6 +431,19 @@ Un document pdf de nom \verb|catalogue_tests.pdf| est pr
 Ce document est rédigé automatiquement sur la base du contenu des rubriques "Auteur", "Mots-cles", "But du test" et "Description du calcul" des fichiers README (voir figure \ref{format_fichier_README}).
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{Ajout d'un nouveau test}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -716,10 +782,94 @@ Actuellement, il n'y a pas d'exemple dans le r
 \end{tikzpicture}
 \end{minipage}
 
-
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \subsubsection{Exemple avancé sur l'utilisation d'un \texttt{.verif} pour un test multiparamètres}\label{section_exemple_test_5}
 **** en cours d'écriture ***
 
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsection{Actualisation du catalogue de tests}\label{section_actualisation_catalogue_tests}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsubsection{Principe}
+Le document \verb|catalogue_tests.pdf| présent à la racine du projet CVS est construit sur la base du fichier \verb|README| présent dans chaque répertoire de test. Ce fichier pdf est créé via \LaTeX. Le script \verb|genere_catalogue_tests.pl|, présent dans le répertoire \verb|Perl|, automatise le traitement en regroupant le contenu des fichiers \verb|README| au sein d'un fichier \verb|.tex| qui est ensuite compilé avec la commande \verb|pdflatex|.
+
+Une fois un nouveau test pr\^et à l'emploi avec un fichier \verb|README| conforme, l'utilisateur peut actualiser ce catalogue en exécutant le script \verb|genere_catalogue_tests.pl|. Ce script recherche tous les répertoires de test depuis son répertoire de lancement. Cela veut dire que l'utilisateur peut très bien tester, dans un répertoire séparé, si ce script fonctionne correctement pour son nouveau test avant d'actualiser la totalité du catalogue. Notamment, si le fichier \verb|README| contient une insertion de figure, cela permet de tester au préalable si les dimensions de la figure sont bien configurées.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsubsection{Exécution}
+Pour exécuter le script \verb|genere_catalogue_tests.pl|, les commandes suivantes doivent \^etre disponibles :
+\begin{itemize}
+\item[-] \verb|pdflatex|
+\item[-] \verb|makeindex|
+\end{itemize}
+~\\
+La procédure de lancement dans un terminal est :
+\begin{itemize}
+\item[1-] se placer dans un répertoire contenant des tests et le répertoire \verb|Perl|
+\item[2-] exécuter le script \verb|Perl/genere_catalogue_tests.pl|
+\end{itemize}
+~\\
+Si tout se passe normalement, le fichier \verb|catalogue_tests.pdf| a été créé dans le répertoire de lancement du script. La version finale actualisée du catalogue (celle regroupant l'ensemble des tests) doit \^etre placée à la racine du projet CVS.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsubsection{Procédure en cas d'erreur}
+
+Il est possible que la commande \verb|pdflatex| rencontre des problèmes pour générer le fichier pdf. Tout ce qui met en défaut une compilation \LaTeX{} avec \verb|pdflatex| provoquera un échec. Les problèmes possibles identifiés à l'heure actuelle sont :
+\begin{itemize}
+\item[-] des caractères ou un encha\^inement de caractères ingérables par \LaTeX{} sont présents dans un fichier \verb|README|
+\item[-] problème d'accès aux librairies. Une compilation \LaTeX{} requiert la présence de certaines librairies, et parfois ces librairies ne sont pas présentes sur la machine de l'utilisateur.
+\end{itemize}
+~\\
+En cas de problème, le script \verb|genere_catalogue_tests.pl| signale l'échec de la création du fichier pdf et fournit deux fichiers :
+\begin{itemize}
+\item[-] \verb|catalogue_tests.tex|
+\item[-] \verb|catalogue_tests.error_log|
+\end{itemize}
+~\\
+A partir de ces deux fichiers, l'utilisateur peut commencer un débuggage manuel. Le fichier \verb|catalogue_tests.tex| est le fichier source pr\^et à la compilation (avec \verb|pdflatex| ou n'importe quel autre moyen pour compiler un fichier \LaTeX). Le fichier \verb|catalogue_tests.error_log| contient l'affichage qui a été produit par \verb|pdflatex|, ce qui permet de prendre connaissance des éventuels message d'erreur. En première approche, le script \verb|genere_catalogue_tests.pl| affiche dans le terminal certaines lignes de ce fichier \verb|.error_log| (celle contenant le mot \verb|error|).\\
+
+\color{blue}
+\noindent\bf Remarque importante :\rm\\
+\indent Le fichier \verb|catalogue_tests.tex| étant pr\^et à la compilation, il est tout à fait possible de s'en servir pour aboutir manuellement à la création du fichier \verb|catalogue_tests.pdf|. Il n'est pas absolument indispensable que ce fichier pdf soit créé par une exécution sans erreur du script \verb|genere_catalogue_tests.pl|. Néanmoins, merci de signaler tout problème d'exécution.
+\color{black}
+~\\
+
+La figure \ref{exemple_erreur_genereation_catalogue} montre un exemple d'affichage produit en cas d'erreur.
+
+
+\begin{figure}[H]
+\footnotesize
+\begin{verbatim}
+Erreur (prog:genere_catalogue_tests.pl) : erreur a l execution de pdflatex
+        Les fichiers suivants ont ete crees pour chercher manuellement la source de l erreur :
+              - catalogue_tests.tex (fichier .tex pret a la compilation)
+              - catalogue_tests.error_log (affichage renvoye par pdflatex)
+
+         (vous pouvez essayer de compiler vous-meme le fichier .tex pour
+          finaliser la creation du catalogue)
+
+        Notamment, le fichier catalogue_tests.error_log contient les erreurs :
+-------------------------------------------------------------------------------------------------
+ > ! LaTeX Error: File `subfiguressss.sty' not found.
+ > Package: infwarerr 2010/04/08 v1.3 Providing info/warning/error messages (HO)
+ > ! LaTeX Error: File `subfiguressss.sty' not found.
+-------------------------------------------------------------------------------------------------
+\end{verbatim}
+\normalsize
+\caption{Exemple d'erreur produit par le script \texttt{genere\_catalogue\_test.pl} (cas d'une librairie .sty introuvable)}
+\label{exemple_erreur_genereation_catalogue}
+\end{figure}
+
+
+
+
+
+
+
+
+
 %%
 \clearpage
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -793,13 +943,26 @@ remarque : modif
 2) correction d'une erreur dans la comparaison absolue : par erreur, la comparaison se faisait toujours par rapport à la précision absolue par défaut (\verb|$PREC_ABSOLU|) sans tenir compte de l'éventuelle modification par fichier \verb|.precision|\\
 \end{itemize}%tiret
 
+\item[$\bullet$] 2016-02-12 (Julien Troufflard) :
+\begin{itemize}
+\item[-] modif script \verb|Perl/genere_catalogue_tests.pl| :\\
+1) suppression du lancement de la commande \verb|makeindex| (en fait, le package imakeidx lance déjà cette commande sous forme d'un appel system par Latex lui-e\^eme. Cette opération était donc redondante)\\
+2) meilleure gestion des erreurs de compilation pdflatex :\\
+    \begin{itemize}
+    \item[$>$] utilisation de l'option \verb|-interaction=nonstopmode| en plus de \verb|-halt-on-error|, ce qui évite à pdflatex de s'arr\^eter sans rendre la main en cas d'absence de fichiers (package .sty introuvable, fichier image introuvable avec \verb|\includegraphics|, etc...)
+    \item[$>$] le script fournit à l'utilisateur le fichier \verb|catalogue_tests.tex| pr\^et à la compilation. Ce qui permet d'une part de chercher manuellement la source des erreurs de compilation, et d'autre part, de donner la possibilité à l'utilisateur de terminer manuellement la compilation du catalogue de tests m\^eme si \verb|Perl/genere_catalogue_tests.pl| n'a pas pu aller jusqu'au bout.
+    \end{itemize}
+\item[-] ajout dans la documentation d'un paragraphe concernant la génération du catalogue de tests (section \ref{section_actualisation_catalogue_tests})
+\item[-] ajout dans la documentation d'un paragraphe regroupant les personnes référentes à contacter (section \ref{section_personnes_referentes})
+\end{itemize}%tiret
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %template d ajout d une nouvelle mise à jour (composé d'une puce "bullet" avec Date et auteur de la modif, suivie d une série de puce "-"
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %\item[$\bullet$] AAAA-MM-JJ (Prénom Nom) :
 %\begin{itemize}
-%\item[-] blabla 1\\
-%\item[-] blabla 2\\
+%\item[-] blabla 1
+%\item[-] blabla 2
 %.
 %.
 %.