modif ajout repertoire FONCTIONS_ET_COURBES dans la doc doc_procedure_verification
This commit is contained in:
rio
parent
3a77bf0bc7
commit
1df14a997c
|
|
@ -105,7 +105,7 @@ citecolor= green %couleur citation biblio
|
|||
\clearpage
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
\section{Introduction {\small \it (Gérard Rio)}}
|
||||
\section{Introduction {\small \textit {(Gérard Rio)}}}
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ L'arborescence du projet CVS est la suivante :\\
|
|||
grow via three points={one child at (0.5,-0.6) and
|
||||
two children at (0.5,-0.7) and (0.5,-1.5)},
|
||||
edge from parent path={(\tikzparentnode.south) |- (\tikzchildnode.west)}]
|
||||
\node[draw] {\bf Verif\_Herezh\rm}
|
||||
\node[draw] {\textbf Verif\_Herezh}
|
||||
child { node[draw, anchor=west] {Batterie (répertoire contenant les répertoires de test)}}
|
||||
child { node[draw, anchor=west] {Doc (répertoire dédié à la rédaction de la documentation utilisateur)}}
|
||||
child { node[draw, anchor=west] {Perl (répertoire contenant divers scripts Perl pour exécuter la vérification)}}
|
||||
|
|
@ -290,6 +290,7 @@ On distingue actuellement deux sortes de tests selon le temps de calcul : les te
|
|||
child { node[draw, anchor=west] {FONCTION\_UNIQUE}
|
||||
child { node[draw, anchor=west] {CHARGEMENT}}
|
||||
child { node[draw, anchor=west] {CONTACT}}
|
||||
child { node[draw, anchor=west] {FONCTIONS\_ET\_COURBES}}
|
||||
child { node[draw, anchor=west] {CONDITIONS\_LIMITES}}
|
||||
child { node[draw, anchor=west] {LOI\_DE\_COMPORTEMENT}}
|
||||
child { node[draw, anchor=west] {PARAMETRES}}
|
||||
|
|
@ -307,6 +308,7 @@ On distingue actuellement deux sortes de tests selon le temps de calcul : les te
|
|||
child[missing] { }
|
||||
child[missing] { }
|
||||
child[missing] { }
|
||||
child[missing] { }
|
||||
child { node[draw, anchor=west] {CALCUL\_COMPLET}}
|
||||
child { node[draw, anchor=west] {AUTRES}};
|
||||
\end{tikzpicture}
|
||||
|
|
@ -349,7 +351,7 @@ Le fichier \verb|.CVisu|[i] d
|
|||
\end{array}
|
||||
\end{equation}
|
||||
\\
|
||||
\bf IMPORTANT : \rm si les fichiers \verb|.maple| et \verb|.maple.ref| contiennent plusieurs lignes de données, seule la dernière ligne est traitée\\
|
||||
\textbf {IMPORTANT} : si les fichiers \verb|.maple| et \verb|.maple.ref| contiennent plusieurs lignes de données, seule la dernière ligne est traitée\\
|
||||
\end{itemize}
|
||||
\item[$\bullet$] comparaison libre définie par un script \verb|.verif|:
|
||||
\begin{itemize}
|
||||
|
|
@ -372,7 +374,7 @@ Un r
|
|||
Les fichiers obligatoires sont :
|
||||
\begin{itemize}
|
||||
\item[$\bullet$] un fichier \verb|README| (informations sur le test, voir trame figure \ref{format_fichier_README})
|
||||
\item[$\bullet$] un \bf unique \rm fichier \verb|.info| (éventuellement vide dans certains cas)
|
||||
\item[$\bullet$] un \textbf {unique} fichier \verb|.info| (éventuellement vide dans certains cas)
|
||||
\item[$\bullet$] les fichiers \verb|.CVisu|[i] (éventuellement vides dans certains cas)
|
||||
\item[$\bullet$] tous les fichiers nécessaires à l'exécution des calculs (maillage \verb|.her|, etc...)\\
|
||||
\end{itemize}
|
||||
|
|
@ -486,7 +488,7 @@ Les fichiers facultatifs d
|
|||
\item[$\bullet$] Pour chaque calcul, il est nécessaire de créer un fichier \verb|.CVisu| (\verb|.CVisu1|, \verb|.CVisu2|, etc...) m\^eme si celui-ci est vide. Ces fichiers servent non seulement à Herezh++ mais également au script \verb|Perl/test.pl| pour repérer les calculs à lancer (un calcul par fichier \verb|.CVisu|[i]).
|
||||
\item[$\bullet$] tous les fichiers \verb|.CVisu|[i] et les fichiers facultatifs nécessaires à l'exécution d'un test (\verb|.verif|[i], \verb|.commande|[i], etc...) ont la m\^eme racine que le fichier \verb|.info| (par exemple, si on a le fichier \verb|nom_fichier.info|, l'éventuel fichier \verb|.verif1| doit avoir pour nom \verb|nom_fichier.verif1|)
|
||||
\item[$\bullet$] le fichier \verb|README| contient obligatoirement les rubriques "But du test" et "Description du calcul" montrées sur la figure \ref{format_fichier_README}. Ces deux rubriques serviront à générer automatiquement une documentation pdf (catalogue de tests). Dans le m\^eme but, les rubriques "Auteur" et "Mots-cles", qui ne sont pas obligatoires, donnent des informations utiles (merci de les renseigner).
|
||||
\item[] \bf Remarque importante : \rm ne pas écrire des lignes de 3 tirets ou plus (\verb|---| ou plus) dans le corps d'une rubrique. Ces lignes servent à repérer les titres de rubriques.\\
|
||||
\item[] \textbf Remarque importante : ne pas écrire des lignes de 3 tirets ou plus (\verb|---| ou plus) dans le corps d'une rubrique. Ces lignes servent à repérer les titres de rubriques.\\
|
||||
\end{itemize}
|
||||
|
||||
|
||||
|
|
@ -798,7 +800,7 @@ HZppfast ligne_1 ligne_2 ... ligne_N | tee nom_calcul.log
|
|||
%%
|
||||
\subsubsection*{$\bullet$ \texttt{.pretrait} :}
|
||||
\begin{itemize}
|
||||
\item[] Le but de ce fichier est d'effectuer des traitements juste \bf avant \rm le calcul. Ce fichier doit \^etre un exécutable programmé dans un langage quelconque mais le mieux est de suivre les m\^emes recommandations que pour le fichier \verb|.verif|. Le script \verb|.pretrait| fournit un indicateur de réussite ou d'échec. Il doit donc afficher une des 2 lignes suivantes :\\
|
||||
\item[] Le but de ce fichier est d'effectuer des traitements juste \textbf {avant} le calcul. Ce fichier doit \^etre un exécutable programmé dans un langage quelconque mais le mieux est de suivre les m\^emes recommandations que pour le fichier \verb|.verif|. Le script \verb|.pretrait| fournit un indicateur de réussite ou d'échec. Il doit donc afficher une des 2 lignes suivantes :\\
|
||||
\hspace*{2cm}\begin{minipage}{\textwidth}
|
||||
\begin{verbatim}
|
||||
|
||||
|
|
@ -832,7 +834,7 @@ Ce script re
|
|||
%%
|
||||
\subsubsection*{$\bullet$ \texttt{.posttrait} :}
|
||||
\begin{itemize}
|
||||
\item[] Le but de ce fichier est d'effectuer des traitements juste \bf après \rm le calcul. Il suit la m\^eme logique que le fichier \verb|.pretrait| avec 3 différences : 1) le message de réussite/échec n'a pas la m\^eme syntaxe, 2) il reçoit 3 arguments, 3) il est exécuté après le calcul Herezh++. Ce fichier doit \^etre un exécutable programmé dans un langage quelconque mais le mieux est de suivre les m\^emes recommandations que pour le fichier \verb|.verif|. Le script \verb|.posttrait| fournit un indicateur de réussite ou d'échec. Il doit donc afficher une des 2 lignes suivantes :\\
|
||||
\item[] Le but de ce fichier est d'effectuer des traitements juste \textbf{ après } le calcul. Il suit la m\^eme logique que le fichier \verb|.pretrait| avec 3 différences : 1) le message de réussite/échec n'a pas la m\^eme syntaxe, 2) il reçoit 3 arguments, 3) il est exécuté après le calcul Herezh++. Ce fichier doit \^etre un exécutable programmé dans un langage quelconque mais le mieux est de suivre les m\^emes recommandations que pour le fichier \verb|.verif|. Le script \verb|.posttrait| fournit un indicateur de réussite ou d'échec. Il doit donc afficher une des 2 lignes suivantes :\\
|
||||
\hspace*{2cm}\begin{minipage}{\textwidth}
|
||||
\begin{verbatim}
|
||||
|
||||
|
|
@ -979,7 +981,7 @@ En cas de probl
|
|||
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\\
|
||||
\noindent\textbf {Remarque importante :}\\
|
||||
\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}
|
||||
~\\
|
||||
|
|
@ -1043,7 +1045,7 @@ Compte-tenu des diverses architectures des machines utilisateur, il est possible
|
|||
\item[$\bullet$] 2015-06-29 (Julien Troufflard) :
|
||||
\begin{itemize}
|
||||
\item[-] création d'un nouveau script (\verb|Perl/genere_catalogue_tests.pl|). Il génère automatiquement une documentation sur les tests (résumé et index pour recherche par mots-clés). Ce document est placé à la racine du projet sous le nom \verb|documentation_tests.pdf|. Le mode de fonctionnement (lecture des fichiers README de chaque test) impose une nouvelle contrainte sur la forme des fichiers README (interdiction d'utiliser des lignes de 3 tirets ou plus dans le corps d'une rubrique README car ce motif signifie la fin d'une rubrique). Cette contrainte est le choix actuel mais peut \^etre modifié à tout moment en définissant une balise de fin de rubrique à utiliser dans les fichiers README (par exemple : \verb|fin_rubrique|) et en indiquant sa syntaxe dans la variable \verb|$MOTIF_FIN_RUBRIQUE| du script \verb|Perl/genere_catalogue_tests.pl|.\\
|
||||
\item[-] Apparition d'une nouvelle rubrique README : \it Auteur \rm (renseigne le ou les auteurs du test avec prénom, nom, adresse mail). rubrique qui appara\^it dans la documentation des tests.
|
||||
\item[-] Apparition d'une nouvelle rubrique README : \textit{ Auteur} (renseigne le ou les auteurs du test avec prénom, nom, adresse mail). rubrique qui appara\^it dans la documentation des tests.
|
||||
\end{itemize}%tiret
|
||||
|
||||
~\\
|
||||
|
|
@ -1158,7 +1160,7 @@ pour ces 2 scripts, une gestion des signaux d'interruption \verb|INT| et \verb|T
|
|||
~\\
|
||||
\item[$\bullet$] 2016-09-07 (Julien Troufflard) :
|
||||
\begin{itemize}
|
||||
\item[-] ajout d'un nouveau répertoire dans l'arborescence : le répertoire \verb|Tests_en_attente_debug/| est créé dans le but d'y placer des nouveaux tests qui ne fonctionnent pas encore. Ils sont en attente de debuggage pour \^etre à terme déplacés dans un endroit approprié du répertoire \verb|Batterie/| une fois résolu. \bf {\color{red} Attention :} \rm il s'agit bien d'y placer des \underline{nouveaux} tests qui ne marchent pas encore. Il n'est pas question d'y déplacer d'anciens tests déjà présents dans \verb|Batterie/| sous le prétexte qu'ils ne fonctionnent plus suite à un changement de version Herezh
|
||||
\item[-] ajout d'un nouveau répertoire dans l'arborescence : le répertoire \verb|Tests_en_attente_debug/| est créé dans le but d'y placer des nouveaux tests qui ne fonctionnent pas encore. Ils sont en attente de debuggage pour \^etre à terme déplacés dans un endroit approprié du répertoire \verb|Batterie/| une fois résolu. \textbf {\color{red} Attention :} il s'agit bien d'y placer des \underline{nouveaux} tests qui ne marchent pas encore. Il n'est pas question d'y déplacer d'anciens tests déjà présents dans \verb|Batterie/| sous le prétexte qu'ils ne fonctionnent plus suite à un changement de version Herezh
|
||||
\item[-] modif des scripts \verb|verifier_exeHZ.pl|, \verb|verifier_exeHZ.zsh|, \verb|Perl/genere_catalogue_tests.pl|, \verb|Perl/verif_existence_repertoire_test.pl| : on omet le répertoire \verb|Tests_en_attente_debug/| pour lister les tests de la batterie (via l'option \verb|-not -path| dans la commande linux \verb|find|)
|
||||
\item[-] modif du script \verb|Perl/test.pl| : ajout d'un 3ème argument pour le script \verb|.verif|. Désormais, le nom du fichier \verb|.info| est fourni en 3ème argument (voir la partie relative au script \verb|.verif| en section \ref{section_fichiers_facultatifs})
|
||||
\end{itemize}%tiret
|
||||
|
|
|
|||
Loading…
Reference in a new issue