# Mkd (Extracteur de documents)/Livre imprimable

Mkd (Extracteur de documents)
https://fr.wikibooks.org/wiki/Mkd(Extracteur_de_documents)
* Ce livre fait environ 58 (format paysage) pages au format A4 (dans la version du 2016-08-25).
* Si vous imprimez cette page, choisissez « Aperçu avant impression » dans votre navigateur, ou cliquez sur le lien Version imprimable dans la boîte à outils, vous verrez cette page sans ce message, ni éléments de navigation sur la gauche ou en haut.
* Cliquez sur Rafraîchir cette page pour obtenir la dernière version du wikilivre.
* Pour plus d'informations sur les version imprimables, y compris la manière d'obtenir une version PDF, vous pouvez lire l'article Versions imprimables.
Une version à jour et éditable de ce livre est disponible sur Wikilivres, une bibliothèque de livres pédagogiques, à l'URL : https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)

# Introduction

mkd est une commande Unix / Linux utilisée dans les fichiers de commandes et dans les Makefile pour maintenir à jour la documentation logicielle.
Des versions sont disponibles pour MASM / MS-DOS et pour Visual studio / MS-Windows.
Très simple et très pratique d'utilisation, mkd peut être proposé aux les travaux pratiques de l'informatique pour l'étude du cycle en V.

# Sommaire

Mkd (Extracteur de documents)
Première partie :
LA COMMANDE MKD

# La commande mkd

* Générer la documentation logicielle
* Ce livre doit être rangé sur l'étagère Wikilivres Informatique
* Systèmes d'exploitation, langages informatiques, logiciels CDU/6/68/681/681.3/681.3.0

## Introduction

mkd est une commande destinée à extraire la documentation pour la maintenance et l'exploitation des logiciels en même temps que la compilation, selon les normes ISO.

## Disponibilité

Les paquets Debian peuvent être convertis pour d'autres systèmes linux avec Alien
    Lien : Site officiel du convertisseur de paquets Alien
* Packages debian - ubuntu amd64 et i386.
* Télécharger mkd_140315.tar.gz archive source sur launchpad.
* Sources et paquets RPM pour systèmes bâtis sur le projet Fedora.
* Sources et distributions pour systèmes Windows et dérivés (Cygwin, Mingw).

## Syntaxe

mkd [-ABCFPSafjlnpstvw] codes chemin_source [chemin_cible]

## Description

mkd
    Les commentaires sélectionnés, dans le pseudo-code, ou tout commentaire, d'un fichier informatisé sont extraits et copiés dans un fichier cible « document » afin de produire la documentation désirée.
    On peut extraire en standard tout document texte de n'importe quelle langue enregistrée au format UTF-8.
    Habituellement les fichiers documents sont:
   * Pour les fichiers de programmation ( Assembleur, Basic, C, etc. );
       Les fichiers documents sont des Organigrammes, des Structures de blocs de codes, des commentaires pour Programmeurs (parfois nombreux), des points de Tests (ou blocs de tests) et 'warnings' avec les numéros de lignes .... Les codes de sélection peuvent être respectivement 'O', 'S', 'P', 'T' et "www" juste après le caractère début de commentaire.
   * Des fichiers spéciaux. Les options de compilation standards permettent de nombreuses possibilités. Elles permettent d'extraire des documents balisés avec des caractères spéciaux (" texte ") (% texte Fin de ligne) etc. Voir les options « -l ligne » et « -p page ».
    Fichiers inhabituels:
       Ajouter un fichier de décodage spécifique à un balisage ( html, xml, etc ).
codes
    Ce sont des caractères alphanumériques. Les commentaires commençant par ces caractères sont extraits du fichier source et sont ajoutés au fichier « document ». Tous les caractères ASCII peuvent servir a coder les commentaires; toutefois on utilise ordinairement des caractères en majuscule, sauf w pour 'warning'. Avec deux étoiles “**”, mkd extrait tous les commentaires. (Voir aussi option t et les exemples).
chemin_source
    C'est le hemin du fichier source (ou fichier de projet: avec option -j)
[chemin_cible]
    C'est le chemin du fichier cible « document ». Par défaut chemin_cible est une copie du chemin_source auquel on remplace le suffixe par le suffixe ´.doc´ jusqu'à la version mkd_120508.

## Options

Voir Shell Interface système. Voir aussi les Notes pour les styles de langages.

### Options compilées et de compilation

Pour visualiser les options compilées il faut interroger la commande mkd:
mkd \? sous Linux ou mkd ? sous Windows. On obtient les options qui ont été compilée avec la version courante de mkd, à la ligne -l et -p.
Ici, l'option -l permet:
    avec # (typé shell) : d'extraire les conditions de compilation (#define, #ifdef, etc)
       Cette option permet de se substituer à l'option impérative -S et d'utiliser l'option -f
    avec % : typé PostScript
    avec - : peut-être ADA ? commentaire ligne que l'on extrait aussi avec avec cat et grep (Voir aussi le manuel de grep)
    Autres options possibles avec -l : \' typé Basic, ; typé Assembleur, etc.
Ici, l'option -p permet d'extraire toutes les chaînes de caractères avec les codes '**'

## Exemples
### Exemple de fichiers sources pour générer la documentation

Quand c'est possible on écrit chaque fonction d'une application dans un fichier séparé, afin de produire une documentation dans un ordre alphabétique.
Quand les fonctions sont regroupées dans un même fichier, la documentation des fonctions apparaîtra dans le même ordre que dans le fichier.
Dans le fichier de la fonction on précise sa syntaxe d'utilisation, le fichier d'entête (header), ainsi que son usage.
Exemple pour la fonction cpp_ : du fichier cpp.c copié du manuel Linux "man 3 cpp" Notez que les logiciels destinés à la traduction doivent être écrits en anglais

### Exemple de fichiers cibles obtenus

* Exemple de fichier d'entête obtenu par la commande: mkd -Ctw H cpp.c cpp.h
    Fichier cpp.h:
* Exemple de fichier pseudo code obtenu par la commande: mkd -Ctnv O cpp.c cpp.txt
    Ci-Dessous: Notez que la première ligne est dûe à l'option -v, les lignes sont numérotée (option -n), seul le texte est copié (option -t) Le « code » d'extration est O comme Organigramme.
    Fichier cpp.txt

### Exemple de fichiers de commandes Shell. Exemple pour générer les manuels et les mettre à jour

Le fichier Update_mkd_en.1.txt doit être imposé au format UTF-8 avec un éditeur comme gedit ou BlueFish, pour être traduisibles dans toutes les langues. Vérifiez votre syntaxe avec GmanEdit (Éditeur Gnome) Note: Ceci est un exemple; Voir aussi: Installation du manuel français

### Exemple de Makefile pour générer la documentation

Toutes les chemins des fichiers de l'application sont regroupés dans un fichier de projet dans l'ordre alphabétique.
    Exemple : "ls -1 *.c > app.prj" qui va contenir le nom de tous les fichiers à examiner pour générer la documentation. Attention, ls -1 (chiffre un) et non -l (lettre 'l')
La ligne de commande "mkd -Cjt H app.prj app.h" génère le fichier d'entête de toutes les fonctions de l'application.
La ligne de commande "mkd -Cjt D app.prj app_functions.documentation" génère le fichier de la documentation des fonctions de l'application. Si le fichier est composé de sources en langages différents il faut remplacer l'impératif -C par -f (find) trouver le langage.
Exemple de lignes dans un Makefile. Dans cet exemple le Makefile se trouve dans le répertoire des fichiers sources du projet.

## Valeurs retournées et messages

mkd retourne la valeur 0 (zéro) en cas de succès, une valeur non nulle en cas d'erreur, et affiche:

## Ressources

Compilations avec:
* gcc sous unix / linux, et bibliothèques standards.
* Microsoft visual studio sous MS-Windows ( Une version est prête à l'emploi, compilée avec Microsoft Visual Studio 2010 )

## Fichiers
### Traductions

Il existe des traductions sous unix / linux: Voir la page Traductions Internationales
* Les langues anglais français sont intégrées dans la distribution 2012 et sont prévues pour les langues espagnol allemand italien ( Les fichiers de traduction .pot et .po sont à votre disposition ) ainsi que sur le site des mainteneurs.
* Les manuels formatés nroff existent pour anglais allemand français et sont prévus pour espagnol italien
* Voir aussi la documentation de gettext pour les traductions.

## Notes

* Il appartient aux programmeurs de veiller à refermer les commentaires, blocs et lignes, par les codes de fermeture appropriés dans les fichiers sources.
    Attention: La fermeture d'un commentaire ligne est un retour chariot (NL, LF, CR/LF) selon les cas. Cette remarque implique un retour chariot en fin de commentaire ligne. Dans ce cas vous devez avoir une ligne vide à la fin du fichier source.
* Jusqu'à la version 2012, mkd ne lit et ne décode pas de façon récursive les fichier inclus par '#include' dans les fichiers sources.

## Droits de copie

© EELL, Éditeurs Européens de Logiciels Libres, EUPL 2007.
    Vous êtes libre de copier reproduire et distribuer le livre selon les termes de la Licence Wikipédia Creative Commons Paternité-Partage des Conditions Initiales à l'Identique 3.0 non transposé (CC-BY-SA 3.0) et licence de documentation libre européenne EUPL European Union Public Licence totalement compatible avec GNU

## Bugs

Mise à jour des bugs.

## Voir aussi

anglais Comparison of documentation generators
mkdcppw, mkdcpp en mode graphique.

## Histoire

La commande mkd pour MS-DOS et nommée mkdoc pour Unix, a été créée au Centre d'Electronique de Montpellier (CEM) en 1986 pour générer la documentation logicielle des interfaces logiciel-matériel. Il n’existait alors pas de logiciel connu pour générer cette documentation aux multiples langages (Assembleur, C, Fortran, Pascal, etc.) Les bibliothèques au format COFF ( Common Object File Format ) permettaient d'obtenir des bibliothèques communes.
mkdoc a peu évolué jusqu'en 2007. Il a été compilé pour MS-DOS, Unix BSD Sun, Linux RedHat, Windows 98, Windows 2000. Les commentaires des fichiers de l'application ainsi que les messages sont restés au format ASCII.
En 2007 le nom mkdoc est abandonné et retrouve son premier nom mkd avec la version 10.01 compilée avec Visual C++ au format de texte ISO-8859-1
En 2012 mkd 12.03 s'adapte au format de texte international UTF-8 pour son internationalisation. Dans la foulée mkdcppw est écrit pour générer la documentation des fichiers de langages style C, (c++, php, etc.) en mode graphique (fenêtres).
Consultez également ces pages dans d’autres projets Wikimedia :

## Notes et références

* Notes Style de langage:
Définition de NL: New Line, fin de ligne.
Les styles impératifs (ABCFPSlp) s'excluent les uns des autres et ne permet pas la recherche de style par l'option '-f' (trouver le style)
   * Style A (Commentaires style Assembleur)
       ; Commentaire NL
   * Style B (Commentaires style Basic)
       REM (après un marqueur ' : ' dans QBasic) Commentaire NL
       ' Commentaire NL
   * Styles C
       /* Commentaire */ : C, C++, C#, Java, Javascript, PHP, VHDL 2008, ...
       // Commentaire NL : C, C++, C#, CSS, D, Delphi, Java, Javascript, PHP, Scilab ...
   * Style F (Commentaires style Fortran 77) voir Style l pour le Fortran 90 et plus récents.
       C ou c ou * Commentaire NL ; C,c ou * en première colonne.
   * Style P (Commentaires style Pascal):
       (* Commentaire *) : AppleScript, Caml, Modula-2, Modula-3, Oberon, Pascal, ...
       { Commentaire } Delphi (Pascal objet)
   * Style S (Commentaires style Shell): Csh, Bash, sh, et autres shells, Makefile, Perl, PHP, Python, Ratfor, Ruby, Tcl, ...
       # Commentaire NL
   * Option l (selon option compilée) ; décodage des lignes. Remplace une commande impérative (ABCFPS) et les trois extractions peuvent être associée simultanément. CD₁ et CD₂ en première colonne, CD₃ n'importe où dans la ligne.
       avec CD₃ = ' ! ' Fortran 90
       avec CD₁₂₃ = ' % ' Latex, Matlab, Postscript, Tex
       avec CD₁₂₃ = ' # ' comme style S
   * Option p (selon option compilée) ; décodage des blocs:
       Avec CD₄ = ' ( ' et CD₅ = ' ) ' : ( Commentaire )
       avec CD₄ = CD₅ = ' " ' Chaînes de caractères " Commentaire "
       avec CD₄ = CD₅ = ' ' ' Chaînes de caractères ' Commentaire '
       avec CD₄ = ' < ' et CD₅ = ' > ' tous les tags
* Remarques: Il est toujours possible d'inclure un style de commentaire dans le commentaire d'un autre style !
* Références
* ↑ ISO/IEC 26514:2008
* ↑ ISO/IEC 26514:2008 prévisualisation
* ↑ GmanEdit (Gnome manpage editor)
* ↑ Package redistribuable Visual C++ 2010 (x86)
* ↑ gettext
* ↑ Licence Publique de l'Union Européenne (fichier pdf)
* ↑ https://fr.wikipedia.org/wiki/Commentaire_(informatique)
Mkd (Extracteur de documents)
Deuxième partie :
EXERCICES

# Exercices
## Introduction

Pour ce faire il faut évidemment disposer du matériel (Extrateur de documents, fichiers encodés, etc.) Nous proposons ici des fichiers déjà disponibles, mais vous pouvez essayer avec vos propres fichiers dans la langue et le langage qui vous convient.

## Télécharger mkd

* Version Windows:
    Binaire 32 bits mkd.10.03.zip (Compilé avec Visual VC10).
    sources-mkd.10.03.beta.zip Pour MSDEV, Visual VC10, UNIX / LINUX.
* Versions Unix / Linux: (Paquets sécurisés sur Launchpad)
    Version Debian / Ubuntu sur Launchpad: Binaires, et sources sous réserve d'adapter les chemins des répertoires man et catman.:
       Paquets pour Ubuntu / Debian
    Version RPM (Fedora): (Paquets sécurisés sur le serveur eell.fr)
       Paquets RPM
       Autres systèmes linux : Convertissez les paquets debian avec la commande alien
* Vous pouvez tenter de compiler mkd sur Mac:
       Exercices en langage C - GCC standard sur Mac

## Sources pour les exercices

Les fichiers ci après sont universels (pour tous les exercices et tous systèmes d'exploitation.)
cpp.c pour exercices
asm.c pour exercices
Autres formats de fichiers

## Exercices élémentaires pour se familiariser avec la commande mkd

VOTRE ATTENTION: À l'impression les solutions n'apparaissent pas dans le texte. Les solutions aux exercices se trouvent dans la section suivante, dans le chapitre nommé Comprendre les options de la commande mkd.
* Vérifiez votre commande mkd. Tapez la commande mkd. L'erreur de syntaxe devrait s'afficher:
* Inspirez-vous du manuel en français ou en anglais
* Observez l'effets des options a,s,t,v,w de la commande mkd
* Observez ensuite l'action des codes de sélection de commentaires D, H, O, P, S, T, w (5 maximun)
* Rappel de la commande: mkd [-ABCFPSafjlnpstvw] codes chemin_source [chemin_cible]
    Dans le répertoire des fonctions, tapez les commandes ci dessous dans un terminal:

### Commande: mkd -Cwsv H cpp.c

Testez mkd -Cwsv H cpp.c ( pour décoder le Header de style C, w pour écraser un fichier existant, s et v pour afficher à l'écran en mode bavard ) :
    Comprendre les options : aperçu 1.1

### Commande: mkd -Cws H cpp.c

    Comprendre les options : aperçu 1.2

### Commande: mkd -Cwts H cpp.c

    Comprendre les options : aperçus 1.3

### Commande: mkd -Cwt H cpp.c *.h

    Comprendre les options : aperçus 1.3

### Résumé des observations sur les options s, t, v

Essayez aussi l'option -n
    Comprendre les options : Résumé des observations sur les options s, t, v

### Créez ou écrasez le fichier cible de l'organigramme cpp.organigramme

* Organigramme simple avec numérotation des lignes: code 'O'
* Organigramme avec structure avec numérotation des lignes: codes "OS"
* Organigramme complet avec les tests warnings et numérotation des lignes: Codes "POSTw"
    Comprendre les options : Solution 1.5

### Crééz ou écrasez le fichier de documentation logicielle html du fichier cpp.c

* Le but de l’exercice est de se familiariser avec l'option -a.
* Le Fichier cible: aura pour nom "cpp-documentation_logicielle_codage.html".
* Créez la tête du fichier html avec le code 'h' options -Cwt
    Exemple: mkd -Ctw h cpp.c cpp-documentation_logicielle_codage.html
* Ajoutez le corps avec le code 'd' et les options -Cat (Option -a comme append, ajouter au fichier cible)
* Ajoutez le pied du fichier html avec le code 'f' et les options -Cat
* Visualisez le fichier cpp-documentation_logicielle_codage.html avec votre navigateur
* Quelle meilleure solution proposez-vous pour créer cpp-documentation_logicielle_codage.html ?
    Comprendre les options : Solution 1.6

## Exercices pour se familiariser avec les fichiers de projets

ci-après: fichier est un nom quelconque sensé représenter votre projet dans le répertoire des fichiers sources.
Utiliser l'option -f (finder): Pour valoriser cette option il serait utile d'ajouter un fichier d'un autre langage de programmation à votre convenance (Trouvez sur wikibooks ou wikipedia). À défaut, recopiez et collez le texte ci-dessous dans un fichier nommé putchar.asm sous Windows ou putchar.s sous Linux, à placer dans le répertoire du projet, avec cpp.c et asm.c Trouvez l'exemple en assembleur Microsoft (MASM) sur wikipédia:
putchar.asm
Ce court fichier est utilisé à titre d'exemple pour donner une solution réaliste aux exercices et peut être remplacé par tout autre fichier en assembleur.
Aperçus et solutions des exercices pour comprendre les "Fichiers de projets"

### Créer un fichier de projet manuellement

Projet exercice.prj ; à créer manuellement avec les fichiers disponibles asm.c cpp.c putchar.s
    Comprendre les fichiers de projets : Aperçu

### Créer un fichier de projet avec les commandes système

Projet exercice.prj ; à créer avec les commandes de votre système d'exploitation; ls, dir.
    Comprendre les fichiers de projets : Solution

### Créer un fichier de commandes pour :

Vous aurez copié les fichiers à éprouver dans le répertoire des essais . exécutez la commande mkd \? pour visualiser les extensions reconnues par votre mkd. Ces extensions dépendent des options de compilation.
Les fichiers sont écrits dans des langages de programmation différents, le but est de créer des documentations globales avec ou sans le finder (option -f).
    Comprendre les fichiers de projets : Aperçus et solutions des "Fichiers de commandes"

#### Mettre à jour le fichier d'entête. header global

(header global, exercice.h)
    Comprendre les fichiers de projets : Solutionl

#### Mettre à jour l'organigramme de chaque fichier de programme

Pseudo-code; Code de repérage 'O', asm.org, cpp.org, putchar.org
    Comprendre les fichiers de projets : Solution et aperçu avec commentaires

#### Mettre à jour la structure de chaque fichier

avec le pseudo code. Code 'S' et 'O' et 'w', fichier.struct Fichier:s asm.struct, putchar.struct.
    Comprendre les fichiers de projets : Aperçus

#### Mettre à jour la documentation globale pour les programmeurs

avec les dates de mise à jour etc. Code 'P' Fichier: exercice.info_programmeurs
    Comprendre les fichiers de projets : Aperçu

#### Mettre à jour de la documentation logicielle globale

(Conception détaillée, Tests unitaires, du cycle en V) Code 'D' Fichier: exercice.docu
    Comprendre les fichiers de projets : Aperçu

### Notes sur le finder

Le finder (trouveur) cherche le style du langage par examen de l'extension du nom de fichier, l'option -f est rarement utilisée.
Extensions spécifique à Windows et MS-DOS: Assembleur, Basic, C, Fortran, Pascal, C ou Prolog.
    .ASM .BAS .C .FOR .PAS .PRO extensions en majuscules ou minuscules.
Extensions spécifique à unix / linux: assembleur, C, Fortran, Ratfor, Pascal, Shell, Cshell
    .s .S .c .h .i .f .F .r .p .sh .csh
Notez que les extensions de fichiers .c .h et .prj sont toujours reconnus alors que .c++, .cpp, .hpp ne sont pas reconnus par le finder tout au moins jusqu'à la version 2012. Il est nécessaire de préciser l'option 'C' dans la ligne de commande.
REMARQUES:
c++, cpp, hpp seront probablement reconnus dans les prochaines mises à jour. Il est relativement facile de l'implémenter dans le fichier "find.inc.c" ou find.i
Les commentaires en style ADA commencent par deux tirets et ne sont pas reconnus en standard par le finder (trouveur) de mkd, cependant si il est facile de l'implémenter dans le fichier "find.i" il faudra aussi créer un fichier spécifique à ADA (ada.c ou ada.i)

## Fichiers de tests unitaires

* Inspirez-vous de la documentation de la fonction cpp_ (fichier cpp.c) pour créer un fichier de commandes qui met la fonction cpp_ à l'épreuve.
* Conditions des tests: tous les tests se feront avec l'option impérative -C
* Vérifiez les options de la fonction: n, s, t, séparément.
    Vérifiez que la numérotation des lignes est correcte dans tous les cas de décodage (lignes et blocs). n, ns. nt, nst.
    Vérifiez que le texte reste à la bonne place dans tous les cas de décodage: toute la ligne (dans la cas de la directive de compilation FULL_LINE), ou texte seul.
       - Vérifiez que les tabulations sont bien prises en charge dans tous les cas, décodage des lignes et des blocs
       - Vérifiez de même pour les espaces.
    Vérifiez que le caractère de fin de fichier n'apparaît pas en fin de texte lorsque le commentaire ne se termine pas par une fin de ligne.
* Documentation:
       Ajouter des modules : Documentation pour éprouver les modules.
       Ajouter des modules : Une solution à cet exercice

## Notes et références

Philosophie de la méthode en génie logiciel avec ADA
* ↑ wikipedia:Assembleur#Macro-assembleur

# Comprendre les options de la commande mkd
## Généralités
### Syntaxe de la ligne de commande

    mkd [-ABCFPSafjlnpstvw] codes chemin_source [chemin_cible]

### Distinguer les options impératives

    Les options de langages en majuscules ABCFPS permettent d'extraire les commentaires codés dans un style de langage générique.
       Le style C par exemple peut décoder le C, c++, c--, c#, CSS, java, javascript, php
    Les options de langage en minuscules l et p
       Ces options dépendent de la compilation CD1, CD2, CD3, CD4, CD5. On peut connaître ces options par la commande mkd \?; options l et p
       Les options -l d'extraction des lignes peuvent être utilisées simultanément;
       les options -l; CD1 et CD2 :'%' '<' et CD3 '!' on peut simultanément extraire le PostsScript, les tags html, les commentaires Fortran 90
       L'option -p d'extraction de blocs permet d'extraire des blocs de chaînes de caractères avec les options CD4=CD5= '\"'. CD1 '(' avec CD5 ')' permet d'extraire des blocs entre parenthèses

### Les options d'extraction et d'ouverture des fichiers anstvw

    L'ouverture des fichiers peut être la création du fichier cible avec l'option -w ou l'ajout avec l'option -a
    Les options nstv sont des options d'extration et d'affichage
       n permet de connaître le numéro de la ligne extraite
       s permet une copie vers la sortie standard (un écran, un fichier, une imprimante, etc.
       t permet d'éliminer les codes d'extraction et les caractères de début et de fin de commentaire
       v mode bavard qui permet d'afficher les conditions d'extraction au terminal ou à la sortie standard

## Exercices élémentaires pour se familiariser avec la commande mkd
#### Commande: mkd -Cwsv H cpp.c

    en mode bavard (-v), vous devez obtenir à la console:
    Le fichier cpp.doc contient:
       Notez qu'avec l'option -v on ne peut pas obtenir un fichier d'entête cpp.h car cette option crée une première ligne avec le nom du fichier.

#### Commande: mkd -Cws H cpp.c

    Sans l'option -v on obtient au terminal:
    Le fichier cpp.doc contient:
       Les options Cw ou Cws ne suffisent pas pas pour créer le fichier d'entête cpp.h car les caractères de commentaires sont recopiés.

#### Commande: mkd -Cwts H cpp.c

Avec l'option -t et sans l'option -v on obtient au terminal:
    Le fichier cpp.doc contient:

#### Commande: mkd -Cwt H cpp.c *.h

    Cette fois le fichier d'entête cpp.h peut être créé correctement et cette syntaxe doit être employée dans les fichiers de commandes, ainsi que dans les Makefiles

#### Résumé des observations sur les options s, t, v

* L'option -v, mode bavard, est inappropriée pour générer des documents imprimables. Elle sert pour la mise au point des fichiers de commandes avec l'option -s
* L'option -s permet la mise au point des fichiers de commandes sans nécessité d'éditer le fichier cible.
* L'option -t est nécessaire pour obtenir des document présentables et imprimables.

#### Créez ou écrasez le fichier cible de l'organigramme cpp.organigramme

* Organigramme simple avec numérotation des lignes:
mkd -Cnstw O cpp.c cpp.organigramme
* Organigramme avec structure avec numérotation des lignes:
mkd -Cnstw OS cpp.c cpp.organigramme
* Organigramme complet avec les tests warnings et numérotation des lignes:
mkd -Cnstw POSTw cpp.c cpp.organigramme

#### Crééz ou écrasez le fichier de documentation logicielle html du fichier cpp.c

* Familiarisation avec l'option -a
mkd -Ctw h cpp.c cpp-documentation_logicielle_codage.html
mkd -Cat d cpp.c cpp-documentation_logicielle_codage.html
mkd -Cat f cpp.c cpp-documentation_logicielle_codage.html
* Solution globale pour un seul fichier:
mkd -Cat hdf cpp,c cpp-documentation_logicielle_codage.html

## Notes et références

Notez que:
    Les options impératives -ABCFPS sont incompatibles entre elles et avec l'option -f (find - trouver le style du langage de programmation).
    Les options -a (append - ajouter) et -w (overwrite - écraser) sont difficilement compatibles ...

# Comprendre les fichiers de projets pour mkd
## Exercices pour se familiariser avec les fichiers de projets

Les fichiers de projets d'extension .prj ou .pj sont des fichiers qui contiennent la liste des fichiers (sources) pour générer les documents (cibles).
Les fichiers de la liste ont parfois des extensions différentes.
Si les fichier sont tous de même style de commentaires on peut imposer une des options impératives pour générer les documents, mais pour utiliser un fichier de projet il est nécessaire de préciser que le fichier source est un fichier de projet avec l'option -j souvent associé à l'option -f (find). Dans le cas où find ne trouve pas le type de fichier, les styles compilés sont proposés à la sortie standard (Terminal en général) L'option -j est compatible avec les options impératives.

#### Créer un fichier de projet manuellement

Projet exercice.prj ; à créer manuellement avec les fichiers disponibles asm.c cpp.c putchar.s
Manuellement on est maître de la liste des fichier et de l'ordre nécessaire au décodage.
Nom du fichier de projet exercice.prj ; dans l'ordre alphabétique:

#### Créer un fichier de projet avec les commandes système

Projet exercice.prj ; à créer avec les commandes de votre système d'exploitation; ls, dir.
* Avec terminal linux: ls
Fichier exercice.prj : La mise en ordre alphabétique est automatique.
* Avec terminal cmd Windows 7, dir: option /B: noms courts, et option /ON: tri alphabétique. Notez que le terminal PowerShell ne convient pas.
Fichier exercice.prj :

#### Créer un fichier de commandes pour :

Vous aurez copié les fichiers à éprouver dans le répertoire des essais . exécutez la commande mkd \? pour visualiser les extensions reconnues par votre mkd. Ces extensions dépendent des options de compilation.
Les fichiers sont écrits dans des langages de programmation différents, le but est de créer des documentations globales avec ou sans le finder (option -f).

##### Mettre à jour le fichier d'entête. header global

exercice.h
La commande doit trouver le type de fichier du projet exercice.prj avec l'option -f
Fichier exercice.h:

##### Mettre à jour l'organigramme de chaque fichier de programme

Pseudo-code; Code de repérage 'O',
asm.org, cpp.org, putchar.org
* mkd -Cstw O asm.c asm.org
* mkd -Cstw O cpp.c cpp.org
* mkd -Astw O putchar.asm putchar.org
(L'exemple putchar avec MASM est forcément sous MS-DOS)
Fichier putchar.org:
Notez que la première ligne est correcte: macro.asm, alors que les commentaires qui suivent sont précédés du caractère O du fait que toute la ligne est recopiée sauf le caractère ; (Ceci est dû à l'option de compilation FULL LINE): La copie de la ligne est entière le caractère de commentaire est remplacé par un espace ligne 256 du fichier asm.c. (Voir asm.struct de l'exercice suivant "Mettre à jour la structure de chaque fichier") Pour éviter ce qui pourrait être un inconvénient il suffit de recompiler mkd sans l'option FULL_LINE. Pour une bonne présentation on a toujours intérêt à écrire le pseudo-code sur des lignes séparées avec le caractère ; en première colonne.
Bug: Un des bugs connus est la fin de ligne qui se termine par EOF à la place de EOL (NL retour chariot)

##### Mettre à jour la structure de chaque fichier

avec le pseudo code. Code 'S' et 'O' et 'w',
asm.struct
mkd -Cswn OSw asm.c asm.struct
Fichier asm.struct (édité avec Bluefish)
Notez la fin de fichier avec le caractère ÿ qui témoigne d'une fin incorrecte sur EOF
putchar.struct
mkd -Aswn OSw putchar.asm putchar.struct
Notez la fin de fichier correcte qui témoigne d'une fin correcte sur EOL (New Line) Notez aussi qu'un des caractères n'est pas au format UTF-8 (le é de défini)

##### Mettre à jour la documentation globale pour les programmeurs

avec les dates de mise à jour etc. Code 'P'
exercice.info_programmeurs
mkd -fjstw P exercice.prj *.info_programmeurs

##### Mettre à jour de la documentation logicielle globale

(Conception détaillée, Tests unitaires, du cycle en V) Code 'D'
exercice.docu
mkd -fjst D exercice.prj *.docu

## Notes et références

Mkd (Extracteur de documents)
MAINTENANCES, MISES À JOUR, ÉVOLUTIONS
Troisième partie :
INTERNATIONALISATIONS
MANUELS ET MESSAGES

# Internationalisation des manuels

Cette page est susceptible de subir des modifications occasionnelles

## Internationalisation des manuels

Les manuels pour UNIX sont écrits en standard au format nroff Les manuels traduits doivent être compressés mkd.1.gz avant d'être transférés dans les répertoires des langues: Les manuels de la version de mai 2012 existent en allemand, anglais et français. Vous pouvez envisager de les traduire dans d'autres langues à partir des références ci-dessous.

## Exemple d'installation des manuels (Fichier de commandes)

Pour d'autres langues que que anglais et français voir aussi le chapitre #Autres_langues
Installation des manuels

## Manuels de référence

* (anglais) Mkd-Manual (english reference manual)
* (français) Mkd, manuel de référence en français

## Manuels traduits

Votre participation pour corriger ces traductions est souhaitée.
* allemand Mkd-Handbuch
* espagnol Mkd-Manual

## Manuels souhaités (à traduire)

* italien Mkd-Manuale italiano Votre participation est souhaitée.

## Mises à jour des manuels internationalisés

* (man1) :
    - Téléchargez la mise à jour des manuels
    - Download the latest multi-lang Installer:
* Attention : Vérifiez les dates de publication de ces pages de manuels en bas de page.
* ↑ Manuels anglais allemand français
* ↑ Translations anglais allemand français

# Internationalisation des messages

allemand↑  anglais↑  espagnol↑  français↑  italien↑
Cette page est susceptible de subir des modifications occasionnelles

## Internationalisation des messages

Les traductions automatiques des messages des applications dépendent directement de la langue que vous avez adoptée à votre connexion. Voyez la ligne LANG votre environnement (Commande env dans un terminal sous Unix/Linux).
Si vous avez adopté la langue française vous devez trouver LANG=fr_FR.UTF-8 sous Linux. Si les fichiers de langue ont été installés pour chacune des applications, dont la langue française que vous utilisez, vous devez avoir les messages en français, sinon, ils doivent apparaître dans la langue universelle en informatique; l'anglais. Les messages de la version de mai 2012 existent en allemand, anglais et français. Vous pouvez envisager de les traduire dans d'autres langues à partir des références ci-dessous.
Pour arriver à ce résultat on balise les messages des fichiers sources avec gettext exemple:
Les messages seront enregistrés dans un fichier .pot avec une première ligne qui est le message d'origine et une deuxième ligne qui servira à la traduction dans un fichier file.po dans la langue voulue: (file est un nom que vous aurez choisi, sans doute le nom de votre application.) Pour plus de détails voyez gettext
file.pot sert de référence pour créer les fichiers .po dans différentes langues.
Pour effectuer la traduction on utilise l'éditeur poedit pour obtenir le fichier file.po. Lorsque l'on effectue plusieurs traductions il faut les différencier dans des répertoires différents ou avec des noms différenst comme file_en.po, file_fr.po.
file_fr.po pour la traduction en français:

### Mise à jour et installation des traductions pour mkd 2012

Notez que la version 2012 n'est disponible que pour UNIX ou LINUX, et que toutes les commandes citées sont disponibles ou ont des équivalents pour les sytèmes d'exploitation courants.
Principe d'installation pour tous les systèmes d'exploitation:
* Télécharger poedit pour Windows ou Mac ou Linux, selon votre système d'exploitation.
* Avec le fichier .pot (Portable object template) créer le fichier .po (Portable object) avec la commande:
    fr est à remplacer par une autre langue maternelle.
    Commande Linux : msginit -l fr -o mkd_fr.po -i mkd.pot
* Convertir le fichier .po au format UTF-8:
    Commande Linux : iconv -f ISO-8859-1 -t UTF-8 filename.txt > UTF8.filename
    et dans l'entête du fichier .po, modifier « ASCII » pour « UTF-8 » ou un format ISO.
* Editer le fichier .po avec poedit et faites la traduction dans votre langue maternelle. Poedit créera le fichier .mo
* Installer le fichier .mo dans le répertoire de la langue correspondante.
    Exemple pour la langue française : (Remplacer « fr » par la langue traduite)
    sudo ou su selon la version de Linux
    Commande Linux : sudo cp mkd_fr.mo /usr/share/locale/fr/LC_MESSAGES/mkd.mo
    Si vous désirez remplacer un fichier .mo existant la commande doit être cp -f
* Les fichiers .mo sont lisibles avec Virtaal.

### Fichier Pot (Potfile)

mkd.pot Référence pour la version mkd-0~120508

### Exemple de traduction en français

ATTENTION Cette traduction en français peut avoir été modifiée et n'est peut-être plus la traduction officielle.
Vous pouvez copier la traduction ci-dessous pour créer une version personnelle, ludique par exemple.

### Autres langues

Traductions effectuées:
* (allemand) mkd_de.po
* (espagnol) mkd_es.po
* (anglais) mkd_en.po Page originale
* (français) mkd_fr.po Cette page
Traductions souhaitées:
* (italien) mkd_it.po Votre participation est souhaitée.

## Notes et références

* ↑ GNU Operating System
* ↑ gettext pour Windows 32
* ↑ http://www.poedit.net/download.php
* ↑ http://www.gnu.org/software/gettext/manual/gettext.html#Creating
Mkd (Extracteur de documents)
MAINTENANCES, MISES À JOUR, ÉVOLUTIONS
Quatrième partie :
CODER
TESTER
INTÉGRER
DOCUMENTER
Exemple de programme pour le cycle en V

# Ajouter des modules

Cette page est susceptible de subir des modifications occasionnelles

## Pourquoi ajouter des modules ?

Il est aisé d'extraire des fichiers, des lignes complètes, contenant une chaîne déterminée de caractères. Voir la commande Grep et Awk.
Les fichiers de textes sont de plus en plus compliqués, il est difficile d’extraire des blocs de commentaires débarrassés des signes de balisage; d'où l'intérêt de créer des modules adaptés aux langages de programmation ou d'éditions utilisant des balises; Postscript, SGML et autres méta langages; Xml, Html, ... .

## Comment ajouter un module ?
### Quel langage de programmation ?

Tous les langages de programmation peuvent convenir à condition qu'ils soient compilable avec gcc pour produire des fichiers objets liables entre eux (linkables)

### Définir le module

Il faut déterminer quel est le style de commentaire à extraire. Repérer éventuellement un fichier similaire existant. Il existe en standard des modules d' extraction de lignes et des modules d' extraction de blocs.
Certains fichiers ont des commentaires plus compliqués comme : <!-- texte --> avec quatre caractères voire plus. Dans des cas plus complexes il pourrait être préférable de repérer des chaînes de caractères plutôt que des caractères ASCII. Ceci aurait l'avantage d'être adapté aux caractères asiatiques en UTF 8, 16, ou 32 avec des chaînes de caractères données paramètres d'entrée.

### Créer le pseudo-code

Le pseudo code que nous utilisons est un commentaire qui va décrire ce que l'on fait et ce que l'on doit obtenir, ce qu'il faut faire dans certaines conditions comme créer une boucle jusqu'à ce que l'on obtienne ce que l'on cherche.
Il y a de nombreux ouvrages qui décrivent les manières de programmer. Le plus célèbre est sans aucun doute la méthode Merise pour la programmation impérative.
Il est préférable d'écrire le pseudo code avant d'écrire les lignes de codes.
Examinez les fichiers à disposition pour avoir une meilleure idée de l'utilisation du pseudo code.

### Intégration des lignes de codes
#### Langue de programmation et internationalisation

Nous utilisons gettext pour adapter les messages aux différentes langues parlées.
Pour que l'on puisse facilement traduire les messages il convient de les écrire en anglais US (ASCII). Les divers caractères accentués des langues européennes ne sont pas si faciles à traduire.

## Compilation de l'unité de test
### Les options du fichier version.h

Le fichier d'entête version.h est utilisé pour compiler la série d'applications dérivées de la commande mkd. La vérification des options est indispensable avant toute compilation.

### La fonction maîtresse - main

La fonction main doit ouvrir les fichiers source et cible et transmettre l'adresse de ces fichiers ouverts à la fonction à éprouver (tester).
Elle doit en retour, s'il y a lieu, d'afficher la valeur de retour de fonction à défaut de d'afficher un message correspondant à cette valeur de retour.
Il n'est pas interdit d'ouvrir "en dur" toujours les mêmes fichiers source et cible, cela dépend des tests demandés. L'essentiel pour les tests unitaires est de répondre aux directives. Il peut cependant être nécessaire d'entrer des arguments comme n, s, t par exemple pour l'épreuve de la fonction cpp_ que nous prenons souvent en exemple.
Exemple complet avec mkdcpp (Éditeur ISO-8859-1)
mkdcpp.c

### Le Makefile pour la compilation de l'unité

Le makefile suivant, mkdcpp.mak complet pour une installation standard a été bridé pour les tests unitaires.
mkdcpp.mak

## Épreuve unitaire
### Générer la documentation unitaire

* La documentation unitaire doit (devrait ?) être intégrée dans le fichier source afin d'être certain que cette documentation concerne CE fichier source.
* On extrait cette documentation par copier-coller ou avec mkd.
* Pour une production importante il faut se référer à la norme ISO..
* Pour une petite production, cette documentation unitaire doit fournir les indications suivantes:
* FILE NAMES: Nom du fichier et nom de la fonction.
* PROJECT: Nom du projet.
* INITIAL PROJECT: Projet initial si le projet a changé de nom.
* ADMINISTRATIVE RECORD: Nom d'enregistrement dans les archives avec la date, le lieu etc.
* UPDATES: Date, auteur, nature de la modification.
* RECOMMANDED TESTS: Description des épreuves pour valider la fonction.
* Description de la fonction: (Utile pour le manuel man 3)
** NAME: Nom de la fonction (Suivi, éventuellement du nom du fichier source, Voir FILES ci après)
** SYNOPSIS: ou SYNTAX: fichiers d’entête (#include) return-value function (parameters);
** DESCRIPTION: ou ACTION: action détaillée et sa description.
** RETURN VALUE: valeurs de retour de la fonction.
** CONFORMING TO: ou STANDARDS: POSIX, ANSI C, BSD, ISO/IEC 9899:2011, gcc, MS-VC10, UTF-8, etc.
** PORTABILITY: LINUX-Debian-systems, LINUX-Red-Hat, Windows NT, etc.
** COPYRIGHT: Droit de copie s'il y a lieu.
** AUTHORS: Concepteur, traducteurs, etc. (Éventuellement)
** RESSOURCES: Si le projet nécessite des ressources particulières (gtkmm, etc.)
** FILES: Fichiers concernés Fichiers d'entête (.h), sources, etc. (où on les trouve)
** NOTES: ou recommandations.
** BUGS: Erreurs constatées ou erreurs courantes.
** SEE ALSO: Voir aussi, au cas où ...

### Éprouver le module (Test unitaire)

Le répertoire des tests unitaire se compose:
* Un ou plusieurs fichiers sources. le fichier source peut simplement s'appeler "Source" mais on préfère lui donner un nom qui le distinguera des autre modules lors des tests d'intégration; par exemple "Test_cpp_U.cc"
* Un fichier de commande des test que l'on peut appeler "Tests" ou "Test_cpp_U" que l'on rendra exécutable sous linux, sous Windows on utilise l'extension ".bat"
* Un fichier de nettoyage "Clean" ou Test_cpp_U.clean. On le rendra exécutable (Même remarque que précédemment)
* Un fichier qui donne le résultat de l'analyse "Analysis" en anglais.

#### Exemple pour le Styles C

* /* ... */ : C, C++, C#, PHP, Java, Javascript, CSS, ...
* // ... NL : C++, C#, PHP, Java, Javascript
Fichiers de tests unitaires de la fonction cpp_ dans mkd
    Tests function files: Test_cpp_U.cc, Test_cpp_U.c
    Bash commands files: Tests, Tests_Clean
File Test_cpp_U.c
File Tests
File Tests_Clean

### Analyse des tests unitaires

Éprouver le module unitaire nécessite de répondre aux recommandations des tests contenus dans la documentation.
Exemple de fichier Analysis
Analysis

## Intégration du module

L'intégration du module se fait par la compilation d'une application qui utilise ce "module", cette fonction: mkd, mkdcpp, mkdcppw par exemple. Le fichier d'entête version.h doit être modifié en fonction des compilateurs et options de compilation.
Ce module peut être intégré par inclusion (#include) avec l'option de compilation gtkmm pour mkdcppw.
Il peut être compilé séparément sous forme d'objet éventuellement intégrable dans une librairie. Le module objet sera lié (Link) à l'application par la compilation. Attention : Une fonction intégrée dans une librairie est figée. Il faut alors veiller à proposer un fichier d'entête correspondant à l'objet; on ne peut plus utiliser version.h.
    Pour la fonction cpp par exemple, il faudra proposer un fichier d'entête cpp.h correspondant à la compilation cpp.o

## Épreuve d'intégration

* Exemple:
* Constater que le module se compile bien dans l'application.
* Vérifier que le module répond bien aux paramètres d'entrée et qu'il prend en compte les variables globales. Vérifier les valeurs de retour de fonction et l'affichage des messages correspondants.
* Reprendre tous les tests unitaires des fonctions avec les fonctions intégrées dans l'application.

## Générer la documentation

* Déterminer à qui s'adresse cette documentation, par exemple:
* Utilisateur final Manuels
* Concepteurs Suivi de la programmation selon les étapes du cycle en V
* Programmeurs Documentation des fonctions et librairies de fonctions Tests unitaires, d'intégration, de validation

## Notes et références

* ↑ ISO/IEC 26514:2008
* ↑ ISO/IEC 26514:2008 prévisualisation
Mkd (Extracteur de documents)
MAINTENANCES, MISES À JOUR, ÉVOLUTIONS
Cinquième partie :
CONSTRUCTION D'UN PAQUET DEBIAN
Exercice de Construction d'un Paquet 'debian'
Dépôt parrainé debian-ubuntu du paquet original mkd-131215

# Exercice de Construction d'un Paquet 'debian' pour la maintenance logicielle

Cet exercice a pour but de se familiariser avec la construction d'un paquet debian. Ce paquet n'est pas censé persister dans la structure linux. Paquet officiel : mkddocu. Voyez la construction d'un paquet mkd officiel (version 131215)
Cette page a été optimisée pour "Version imprimable". Si vous désirez imprimer cette page assurez-vous que les textes déroulants ne sont pas masqués.
Les paquets d'installation des logiciels pour les systèmes d'exploitation linux permettent de sécuriser les systèmes grâce à des clés numériques. Ils permettent aussi de faciliter l'installation des applications.
La description qui suit ne conduit pas à la construction d'un paquet sécurisé

## Créer un paquet debian

La lecture de la documentation sur le sujet est si obscure qu'il est bien difficile de créer son premier paquet. L'objet de cet article est de voir, au travers d'un exemple simple, comment sortir de l'obscurité.
Le paquet debian que nous allons créer ne sera pas sécurisé et ne pourra pas être installé par le gestionnaire de la logithèque. Il sera simplement installé et désinstallé par des commandes shell.

## Le paquet

* L'idée de la démonstration est de créer un utilitaire très simple à l'usage des programmeurs avec l'aide de la commande mkd.
* Nous nous sommes inspirés de l'article myecho pour vous proposer cette commande que nous appellerons mkmaintainerdocu (Make maintainer documentation)
* Cette commande n'a pas pour ambition de persister dans les répertoires des commandes binaires (/bin, /usr/bin, etc.)

### Que doit-il faire ?

* créer un fichier de projet pour une application écrite en langage C
* générer le fichier d'entête de l'application "<projet>.h
* générer la documentation des fonctions
* générer la documentation destinée aux programmeurs
* Si possible afficher les fichier à la fin de leur création ou modification.

### Choix de l'exécutable

Le plus simple est de créer une commande shell bash↑, facile à maîtriser et inspirée par myecho cité dans les références.

### Structure de l'archive projet-mkmaintainerdocu.tar.gz

"./" est le répertoire conteneur que nous pouvons appeler projet-mkmaintainerdocu Il contient nos utilitaires et les fichiers d'installation. "./mkmaintainerdocu" est le répertoire racine de notre paquet. Ce qui nous intéresse se trouve DANS ce répertoire.

#### changelog.debian

* fichier nécessaire à la création du paquet, peut être vide.

#### copyright

* fichier nécessaire à la création du paquet, peut être vide.

#### changelog

* fichier nécessaire à la création du paquet, peut être vide.

#### README

* fichier utile à la construction du paquet

#### mkmaintainerdocu

* notre fichier shell qui va exécuter nos commandes de création des documents

#### postrm

* shell exécuté après la suppression du paquet (si nécessaire)
* cet exécutable peut exécuter des mises à jour comme 'cat', 'whatis', et d'autres ...

#### control

* fichier nécessaire à la construction du paquet
* Le classement des paquets doit être choisi dans une des sections : admin, devel, doc, graphics, libs, misc, net, otherofs, pyton, shells, sound, text, utils, x11.

#### postinst

* shell exécuté après la création du paquet (si nécessaire)
* cet exécutable peut exécuter des mises à jour comme 'cat', 'whatis', et d'autres ...

### utilitaires
#### KONSOLE

Cet utilitaire facilite l'ouverture d'une console dans le répertoire courant.

### Contenu extrait du paquet

* L'extraction avec le gestionnaire d'archives recrée les répertoires avec la même structure.

## Tests

Boîte des tests

### Résultat des tests
#### Liste de l'archive myproject.tar.gz
#### Fichier d'entête (header)

project.h:

#### Directives de programmation et de tests

* project-functios-directives.txt

#### Manuel des fonctions

* project-functions-documentation

#### Document à l'usage des mainteneurs
## Sécurisation des paquets

Les paquets non sécurisés sont à proscrire.
Boîte de sécurisation des paquets

### Créer un nouveau paquet sécurisé

Make-new-ppa : Pour créer un dépôt ppa.
Il faut noter que toutes les options citées pour l'exécution de dh_make ne sont pas nécessaires. On peut supprimer la plupart des fichiers créés dans debian si on utilise une compilation simple de l'exécutable avec 'make'. Cependant, pour la portabilité sur d'autres machines avec des processeurs différents x86, amd64 etc. il est nécessaire de re-compiler l'exécutable; c'est le fichier exécutable 'rules' qui devra prendre en charge les différentes versions.

### Compilation et envoi au dépôt ppa:

* Build-and-put-to-ppa

## Suggestions

* Si vous utilisez souvent les mêmes codes d'extraction, vous pouvez créer un shell pour la maintenance dans le répertoire /usr/local/bin, sans pour cela créer un paquet ....
* Les paquets sont réellement utiles lorsque l'installation est complexe ou pour une meilleure sécurité par un dépôt officiel (Voir Launchpad)

## Liens utiles

Créer un paquet ubuntu
Liste 'complète' ? des pages décrivant l'utilisation des paquets sous Ubuntu

## Références

* ↑ Dépôt officiel de mkddocu : mkd-doc_140515_all.deb
* ↑ http://alp.developpez.com/tutoriels/debian/creer-paquet/

# Exemple de dépôt parrainé debian-ubuntu du paquet original mkd-131215

       Cette page a été optimisée pour "Version imprimable"
Les paquets d'installation des logiciels pour les systèmes d'exploitation linux permettent de sécuriser les systèmes grâce à des clés numériques. Ils permettent aussi de faciliter l'installation des applications.
Un paquet original est le premier paquet d'une série. Le paquet natif 131215 a été créé pour un nouveau dépôt ppa (Personnal packages) personnalisé par l'équipe de maintenance de l'EELL (Éditeurs européens de logiciels libres)

## Créer la hiérarchie des fichiers et répertoires de travail
### Répertoires

* ~Packaging/mkd/mkd-131215/ répertoire de travail qui contient :
* les fichiers de commandes Make-new-ppa, Buid-all, Rebuild-all.
* le répertoire origine ./mkd-0~131215 Contiendra le Makefile de création du paquet et les documents README, NEWS, etc.
* le répertoire des sources ./mkd-0~131215/src Contiendra tous les fichiers nécessaires à la compilations des sources
    4. le répertoire des binaires et des données ./mkd-0~131215/usr On pourra prévoir de les créer avec un Makefile ou les placer dores et déjà dans la hiérarchie 'usr' lorsque ces fichiers ne nécessitent pas de nouvelle compilation : les manuels, langues, icônes etc. :
Notez que :
* le seul fichier qui nécessite d'être mis à jour et placé dans le répertoire usr/bin/, est le binaire mkd adapté au processeur. (i386, amd64, ...)

## Création du sous répertoire debian

Le répertoire ./mkd-0~131215/debian est créé à l'aide du fichier de commande 'Make-new-ppa' que nous avons placé au dessus du répertoire origine pour simplifier la création des divers paquets.

### Options dh_make

    -c GPL; general public licence (gpl2, gpl3, lgpl, lgpl2, lgpl3, artistic, apache, bsd ou mit)
    -e adresse électronique des mainteneurs
    -s seulement le binaire
    -n natif, ne pas générer d'archive .orig
    -f mkd-0~131215.tar.gz Ce sera l'archive originale
    -r CDBS directive pour créer le fichier de commande 'rules'

## Fichiers nécessitant une explication
### debian/changelog

Notez que :
* à la création, l'option -n a initialisé la version "* Initial Release"
* nous avons modifié la première ligne pour préciser la version saucy (ubuntu 13.10)
* ici, dans ce cadre, l'adresse de courriel est masquée pour éviter les spams

### debian/control

Notez que :
* le créateur de fichier a bien fait son travail ...
* nous avons ajouté la 'Description' qui sera affichée à l'installation par le gestionnaire d'archives
* d'autres champs peuvent être indispensables
* si le copyright n'apparaît pas à l'installation avec le gestionnaire d'archives il est possible, si c'est indispensable, de l'ajouter à la fin la description longue.

### debian/copyright

Notez que :
* l'option -c GPL a automatiquement créé la licence GPL-3+
* nous avons ajouté les droits de copie et les licences depuis l'origine du fichier
* ce droit de copie va apparaître dans les docs '/usr/share/doc/mkd/. ' et n'est pas vraiment nécessaire si on propose les fichiers HISTORY ou/et COPYING ou/et AUTHORS avec les droits détaillés.

### debian/rules

Notez que :
* le fichier a été créé par l'option '-r CDBS'
* nous avons ajouté les commentaires de la notice
* notre nettoyeur s'appele 'mrproper' dans le Makefile d'empaquetage. on aurait pu utiliser le traditionnel 'clean'
* mkd est l'exécutable qu'il faut générer pour chaque configuration de processeur
* install va copier les fichiers ./mkd-0~131215/usr/* dans le répertoire ./mkd-0~131215/debian/mkd/usr/* .
A titre indicatif, il est possible d'utiliser une variante install DESTDIR=debian/mkd à condition de le prévoir; cette solution permet de créer un fichier temporaire de test avec install DESTDIR=debian/tmp/ (Pas vraiment utile !)

### debian/doc

les fichiers NEWS à INSTALL seront copiés dans le répertoire ./mkd-0~131215/debian/mkd/usr/share/doc/mkd/ avant d'être recopié dans /usr/share/doc/mkd/. à l'installation du paquet.
Notez que :
* ces fichier sont dans le répertoire origine
* ces fichiers ne sont pas tous indispensables. Les fichiers intéressant sont le plus souvent
    NEWS qui sont les nouveautés par rapport aux versions précédentes
    README qui sont les commentaires qui concernent ce paquet.
Vous pouvez ajouter :
* AUTHORS avec le droit de copie spécial à chaque contributeur
* COPYING même chose que Copyright, mais peut spécifier des particularités notamment si une partie du logiciel contient une autre source.
* HISTORY décrit l'historique et les péripéties du logiciel si il y a lieu
* INSTALL est généralement créé par un 'autotool'. Dans ce cas in est inutile de l'intégrer dans les docs, Dans notre cas on peut y préciser une autre manière d'installer le logiciel sans le paquet (qui ne sera donc pas automatiquement mis à jour)
On peut ajouter d'autres fichiers tels que :
* SURVEY souvent pour obtenir un soutien financier, mais ce peut être aussi un appel à contribution technique
* TRANSLATIONS demande d'aide pour traduire les messages et les manuels.
* ...etc.

### debian/postinst

Ce fichier sera exécuté après l'installation du paquet et doit mettre les bases de données à jour.
Notez que :
* Si le manuel man1 du logiciel a été installé on peut aussi ajouter, en cas de nécessité, la mise à jour de la base de données 'whatis'. C'est en principe automatique ....

### debian/postrm

Ce fichier sera exécuté après la désinstallation de l'application pour mettre les bases de données à jour.

### Makefile d'empaquetage

* Le fichier le plus important du répertoire origine est le Makefile

## Création du paquet (debuild)

Notez que :
* ceci est la phase finale
    debuild -S -sa -k49E6B949 va créer les fichiers nécessaires à la recompilation des paquets sur le dépôt.
    dput ppa:jean-paul-louyot/mkd mkd_0~131215-1_source.changes. Il faut attendre quelque temps avant que le résultat nous parvienne en positif ou échec
    debuild -i -us -uc -b va créer un paquet local .deb

## Échecs et mise à jour de paquets

Créer et administrer un dépôt sur launchpad

### Éviter les échecs

ATTENTION : Le dépôt va utiliser l' archive d'origine dans toute la suite des procédures de mises à jour. Si vous avez modifié le Makefile par exemple, il est nécessaire de tout reprendre ou de faire un patch, car l'archive d'origine du dépôt ne va pas contenir le même Makefile, donc pas la même somme de contrôle. Il est aussi possible de conserver, dans une archive native, le répertoire d'origine avec son sous répertoire debian; cela permet de conserver une mémoire des mises à jour .

#### Il est à noter que

* les archives d'origine de série ne contiennent pas le répertoire debian
* le répertoire debian est contenu dans une archive séparée .debian.tar.gz

#### Exemple de noms d'archives

* Archive du répertoire d'origine : <répertoire>-<version>.tar.gz
* Archive d'origine native : <répertoire>_<version>.tar.gz
* Archive d'origine de série : <répertoire>_<version>.orig.tar.gz
* Archive d'origine de série : <répertoire>_<version>-<n>.orig.tar.gz où <n> est une suite successive de série 1, 2, 3, etc.
Pour faire les essais il est préférable de lancer la commande 'Rebuild-all' (Clara pour le chiffrage du transfert)
Pour éviter les échecs : Vérifier si tout se passe bien avant d'envoyer le fichier au dépôt.

### Échecs

Le transfert au dépôt ne se passe pas toujours très bien, il est rejeté. Il est nécessaire de corriger la construction du paquet.
Les rejets sont souvent dus aux commandes incluses dans le fichier Makefile.
Évitez d'utiliser des commandes susceptibles de renvoyer une valeur différente de zéro.
* Ecrivez rm -f <fichier> plutôt que rm <fichier>. rm -f renvoie zéro même si <fichier> n'existe pas.
* Supprimez le binaire dans la dépendance clean, faute de quoi le binaire ne sera pas mis à jour pour un autre processeur bien qu'il n'y ait aucune erreur de syntaxe.
* Vérifiez la validité des dépendances. N'écrivez pas clean : <fichier> ça n'a pas de sens.
* Veillez à ce que le contenu du répertoire soit propre, identique après compilation :
      * De telle sorte que la somme de contrôle du répertoire soit la même après compilation; que tous les fichiers créés soient effacés.
      * Effacer tous les fichiers '.o' (rm -f *.o) par exemple, ainsi que le nouvel exécutable qui a déjà été copié dans debian/mkd/usr/bin/
Launchpad renvoie des informations à l'auteur du transfert (Erreurs communes, la raison de l'échec, etc.)
    Rejected: Unable to find distroseries: unstable
       Dans debian/changelog il faut remplacer unstable par une version d'ubuntu : precise, ou version actuelle
    Rejected: Unable to find section: unknown
       Dans debian/control il faut remplacer unknown par la 'Sous-section' concernée : devel pour nos applications
Si vous renvoyez le fichier tel quel avec la correction, il sera refusé si le fichier .upload se trouve dans votre répertoire:
    <UPLOADE_FILE> already exists in <LOCATION>
    Rejected because the logfile <package>_source on <host> .upload exist. Just remove the .upload file and re-run dput, or invoke dput with the flag -lf (-l run lintian before the upload; -f force an upload of an already uploaded package)
    Il faut supprimer le fichier .upload ou renvoyer le paquet corrigé avec les option -lf dput -lf [host [:arg]] package.changes
    Remarque : On peut éviter l'écriture du fichier .upload avec -option -U : dput -U
Résumé en cas d'échec :

#### Si vous ne modifiez que les fichiers du répertoire debian dans une série

    Vous pouvez renvoyer les fichiers reconstruits après avoir effacé le fichier .upload
    → Dans une série, l'archive du répertoire debian est séparée. Suffixe: .debian.tar.gz

#### Si vous modifiez un fichier du répertoire origine, contenant aussi le répertoire debian, il faut reconstruire le paquet !

* recharger l'original
* régénérer la source
* faire un patch ou reconstruire le paquet avec un numéro de version supérieur à la version en échec
* tester le transfert avec l'option dput -o, débugger avec l'option dput -d, simuler avec dput -s
* transférer le paquet source avec les changements (source.changes) avec dput -lf
* accessoirement, supprimer la version en échec sur launchpad. Cela peut arriver si on change de version Ubuntu dans le fichier changelog. (ATTENTION : La version n'apparaît plus, mais n'est jamais complètement effacée.)

### Mise à jour de paquets

* Voir Mise à jour de paquets

#### Cas traités

    1 L'intention d'empaqueter (création de paquets multiples)
    2 Patch (rustine)
    3 Mettre à jour (création de paquets binaires simples)
    4 Nouvelle version (Paquets natifs)
    5 Dépôts sur Launchpad

## Notes et références

* Notes :
    Discussions autour de l'empagetage debian et rpm ( mot de passe antispam : mkd )
* Références :
* ↑ https://launchpad.net/~jean-paul-louyot/+archive/mkd
* ↑ http://www.debian.org/doc/manuals/maint-guide/dreq.fr.html
* ↑ Créer et administrer un dépôt sur launchpad
* ↑ https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Dépôt_parrainé_du_paquet_''original''_mkd-131215/Mise_à_jour_de_paquets
* Mise à jour de paquets Debian-Ubuntu
* Vous envisagez d'empaqueter ou de mettre à jour une de vos applications.
* Vous désirez personnaliser un paquet existant pour :
* votre usage personnel,
* proposer votre version sur votre dépôt personnel (ppa:)
* La suite des solutions aux exercices d'empaquetage devrait vous y aider.
* À petit pas, avec les erreurs communes et leurs solutions.

### Votre participation est souhaitée pour faire évoluer les projets mkd; vous pouvez

   * modifier les sources de mkd et ses dérivés (mkdw, mkdcppw, etc.) avec les restrictions d'usage : Consultez le copyright de chaque application ; citez l'origine de l'application et le nom des auteurs.
   * participer aux traductions.
   * Prérequis : Avoir installé les paquets suivants : debhelper cdbs lintian build-essential fakeroot devscripts pbuilder dh-make debootstrap.

### Sigles usuels que vous pouvez rencontrer

    Paquets en souffrance et paquets souhaités
    Bogues, ITP:intention d'empaqueter, RFA:paquets disponibles à l'adoption, O:orphelins, RFH:demande d'aide, RFP:demande à empaqueter

## L'intention d'empaqueter

Bien entendu, nous n'allons pas déposer une requête à Debian. Nous nous contenterons des dépôts sur les serveurs Launchpad et des sources du projet mkd.
Dans l'intention d'empaqueter on suppose, à priori que l'application n'a jamais été empaquetée, elle s'installe très bien avec une procédure par un fichier de commandes 'install.sh' ou avec 'make' dans un répertoire d'installation contenant le fichier 'Makefile'

### Exemple d'un Makefile original

Pour empaqueter il est nécessaire de disposer d'un fichier 'Makefile' contenant une directive 'clean' et d'une directive d'installation de l'application dans les répertoires usuels (Compilation, manuels, traductions, etc.) L'empaquetage se fera dans le répertoire debian. Le binaire doit se trouver dans debian/<app>/usr/bin/, et pas dans /usr/bin/. Pour que ce soit possible il est nécessaire d'introduire une macro $(DESTDIR).

### Modifier le Makefile pour l'empaquetage
#### Il est nécessaire

* de déplacer en tête de fichier la dépendance de création du binaire $(PGM)
* vérifier que la dépendance 'install' dépende de la création du binaire; "$(PGM)" dans ce Makefile
* d'effacer le fichier binaire $(PGM) dans la dépendance inconditionnelle 'clean'. Elle sera la première exécutée à la création du paquet
* d'inclure les commandes séparées du Makefile précédent ./install_*
* d'ajouter la macro $(DESTDIR)
* de vérifier qu'aucune commande risque de retourner inutilement une valeur différente de zéro par exemple en cas d'absence de fichier à effacer.
* nettoyer le répertoire à la fin de la compilation.

### Tester la compilation
#### Contenu du répertoire des tests. S'assurer que

* le binaire mkd a bien été créé et copié dans le répertoire usr/bin/
* tous les fichiers ont été copiés dans les répertoires usuels
Listing du répertoire "tests"

#### vérifier que le contenu du répertoire d'origine n'a pas changé

* vérifier les dates, éventuellement mettre les dates à jour avant de lancer le test. commande touch -a
* s'assurer que le binaire a été effacé

### Créer la configuration d'empaquetage

   * Cela se traduit par la création d'un répertoire debian dans le répertoire racine.
   * Ce répertoire debian contiendra tous le fichiers nécessaires à l'empaquetage.
Cette commande va créer le répertoire debian et le fichier .orig.tar.xz au dessus du répertoire racine et se traduit par des questions :
* Type of package: single binary, indep binary, multiple binary, library, kernel module, kernel patch?
    l'option '-s' ne devrait être utilisée que pour produire un binaire mais on peut créer un paquet binaire plus complet avec le manuel et de la documentation.
    l'option '-m' produit deux paquets : un paquet binaire et un paquet -doc commun à tous les paquets binaires générés.

#### Pour notre exercice on peut, à priori,

* supprimer tous les fichier se terminant par '.ex', sauf postinst et postrm qui nous serviront à mettre les bases de données à jour après installation et désinstallation.
* effacer les fichiers DEBIAN.* et le fichier mkd.doc-base.EX

#### Il est nécessaire de modifier

* changelog : remplacer 'unstable' par votre version d'Ubuntu, 'saucy' pour ubuntu-13.10, en minuscules.
* control :
       Section il est impératif de remplacer unknown par devel (sous-section de Développement) ou autre sous-section ...
       Maintainer compléter l'adresse électronique
       Homepage compléter l'adresse des mises à jour
       Description Les paquets mkd et mkd-doc doivent être présentés dans le paragraphe d'affichage dans l'installeur de la Logithèque Ubuntu
       Ajouter Recommends: et "Suggests:" pour, à l'installation, faire référence à l'un et à l'autre paquet.
    fichier control d'essais :

#### Autres fichiers à mettre à jour

* docs : Contient les fichiers documentaires du répêrtoire d'origine : README, INSTALL, UNINSTALL, COPYRIGHT, AUTHORS etc. Si ce fichier est vide c'est que ces fichiers n'existaient pas à la création du répertoire debian. ces fichier se trouveront dans /usr/
* copyright : Éditer et compléter ...
* postinst : Inclure les commandes tels que les mises à jour non exécutable à la fabrication du paquet.
* postrm : Idem !
       Ajouter les quatre lignes de mise à jour des bases de données.

### Empaqueter
#### La commande suivante va lancer la construction du paquet

En cas d'erreurs la construction sera annulée et la lecture du fichier mkd_0~120302-1_<processeur>.build vous permettra de savoir où et pourquoi la compilation s'est arrêtée.
Dans notre cas, alors que la compilation s'était bien déroulée dans les tests nous obtenons une erreur :
Correction de la ligne OBJS

#### À la relance de la construction tout se passe bien et nous obtenons

edeulo@jpl-ubuntu-13:~/Packaging/mkd/mkd_12XXXX/mkd-120302-exercice-0$ ls -al total 252 drwxr-xr-x 4 edeulo edeulo 4096 janv. 13 12:04 . drwx------ 6 edeulo edeulo 4096 janv. 12 18:00 .. -rwx--x--x 1 edeulo edeulo 375 mars 12 2013 KONSOLE drwx------ 6 edeulo edeulo 4096 janv. 13 12:04 mkd-0~120302 -rw-r--r-- 1 edeulo edeulo 14058 janv. 13 12:04 mkd_0~120302-1_amd64.build -rw-r--r-- 1 edeulo edeulo 1004 janv. 13 12:04 mkd_0~120302-1_amd64.changes -rw-r--r-- 1 edeulo edeulo 2748 janv. 13 12:04 mkd_0~120302-1_amd64.deb -rw-r--r-- 1 edeulo edeulo 205340 janv. 12 18:20 mkd_0~120302.orig.tar.xz -rw-r--r-- 1 edeulo edeulo 2124 janv. 13 12:04 mkd-doc_0~120302-1_all.deb drwxr-xr-x 5 edeulo edeulo 4096 janv. 12 16:35 tests

#### Notes

* Le fichier mkd_0~120302.orig.tar.xz a pour date : janv. 12 18:20
* En dehors du fichier Makefile rien n'a changé dans le répertoire d'origine. Les fichiers objets *.o ont bien été effacés.
On peut maintenant mettre à jour l'archive d'origine .tar.xz
* Déplacer le répertoire debian. N'oubliez pas le point '.' mv -v mkd-0~120302/debian .
* Créer le fichier d'origine .tar.xz tar cvJf mkd-0~120302.tar.xz mkd-0~120302
* Vérifier que la taille du fichier d'origine est à peine plus grande que le fichier orig.tar.xz -rw-r--r-- 1 edeulo edeulo 205340 janv. 12 18:20 mkd_0~120302.orig.tar.xz -rw-r--r-- 1 edeulo edeulo 205384 janv. 13 15:37 mkd-0~120302.tar.xz
* Replacer le répertoire debian précédemment déplacé mv -v debian mkd-0~120302/.
* Effacer le fichier mkd_0~120302.orig.tar.xz rm mkd_0~120302.orig.tar.xz
* Recréer le paquet avec le nouveau fichier d'origine Dans le répertoire d'origine : debuild -i -us -uc -b

#### Vérifier le contenu des paquets .deb avec le gestionnaire d'archives ou dans le répertoire debian

Notes :
* Ces archives sont quasiment vides, il n'y a aucun binaire dans le paquet binaire, on le vérifie aussi en consultant le répertoire debian/mkd
* Le répertoire debian contient un répertoire tmp qui, lui contient toute l'archive.
Conclusion dh_install n'a pas fonctionné pour le paquet binaire.
Le manuel de dh_install nous apprend que chaque paquet est construit par un fichier debian/<paquet>.install. Or, si le répertoire debian contient bien un fichier de construction mkd-doc.install, il manque le fichier de construction binaire mkd.install que nous allons créer. C'est hélas courant avec ces paquets multiples.
* On copie le listing du fichier des tests que l'on colle dans un fichier debian/mkd.install
* On supprime toutes les lignes qui ne contiennent que des répertoires.
* On supprime le préfixe tests/ de toutes les lignes qui restent.
* À chaque ligne on ajoute le répertoire où le fichier doit être copié.
Fichier mkd.install : Fichier à copier du répertoire debian/tmp vers le répertoire debian/mkd
On relance debuild -i -us -uc -b
Cette fois le paquet binaire est complet.

#### Pour information

* Éditer le fichier .changes. Notez le contenu. Le champ Date est la date de la mise à jour extraite du fichier changelog alors que le paquet a été construit le jour suivant.
* Éditer le fichier .build et vérifier qu'il n'y a pas d'erreur ou d'incompréhension. Exemple, ligne 204 : W: mkd: bad-homepage <insert the upstream URL, if relevant>

#### Actions complémentaires

* Modifier ou compléter les fichiers changelog, control, copyright, s'il y a lieu.
* Si tout est correct, le paquet est prêt à être installé sur la machine locale.

#### Remarques

* Nous n'avons rien touché au répertoire d'origine
* À l'installation du paquet, avec la Logithèque Ubuntu ou GDebi, le copyright, les suggestions de paquets et les paquets recommandés, n'apparaissent pas.

### Préparer le paquet pour un dépôt
#### Rappel, consultez le chapitre Dépôt sur Launchpad

    Pour déposer un paquet il faut disposer d'un compte de dépôt (PPA), et d'une clé PGP

#### Créer les conditions de transfert sécurisé

Si l'option -sn de debuild ne fonctionne pas il faut utiliser l'option -sa et simuler une nouvelle version .orig.tar.xz
* renommer le répertoire mkd-0~120302.tar.xz mkd_0~120302.orig.tar.xz
* entrer dans le répertoire d'origine mkd-0~120302
* sécuriser le transfert avec la clé de Edeulo 230B1A04 debuild -S -sa -k230B1A04
* sortir du répertoire d'origine.

      #### Liste des nouveaux fichiers

       -rw-r--r-- 1 edeulo edeulo 3264 janv. 15 14:53 mkd_0~120302-1.debian.tar.gz
       -rw-r--r-- 1 edeulo edeulo 1486 janv. 15 14:53 mkd_0~120302-1.dsc
       -rw-r--r-- 1 edeulo edeulo 1407 janv. 15 14:53 mkd_0~120302-1_source.build
       -rw-r--r-- 1 edeulo edeulo 1723 janv. 15 14:53 mkd_0~120302-1_source.changes
       -rw-r--r-- 1 edeulo edeulo 205384 janv. 13 15:37 mkd_0~120302.orig.tar.xz
       L'archive mkd_0~120302-1.debian.tar.gz contient l'essentiel du répertoire debian.
       L'archive mkd_0~120302.orig.tar.xz contient le répertoire de référence d'origine.
       Les fichiers .dsc et .changes sont sécurisés pour le transfert au dépôt.
       Le fichier .build liste le détail de l'opération de sécurisation.
    5. Vérifier le paquet
       dput -ol ppa:<nom-du-ppa>/mkd mkd_0~120302-1_source.changes
    6. Simuler le dépôt
       dput -s ppa:<nom-du-ppa>/mkd mkd_0~120302-1_source.changes
    7. Tenter le dépôt du paquet sur Launchpad; il peut encore y avoir un rejet.

## Patch (rustine)

La rustine informatique est destinée à corriger les bogues apparus au cours de l'utilisation du logiciel, ou pour ajouter des fonctionnalités particulières.
Dans notre cas, à titre expérimental, on peut appliquer des rustine à des fichiers acceptés par le dépôt et qui ont fait apparaître des erreurs de compilation.
* Appliquer une rustine est nécessaire pour le 'suivi' d'une application
* Le travail nécessaire pour appliquer une rustine informatique est assez lourd. Il est souvent plus facile de créer une nouvelle version avec les défauts corrigés.
    Il se pose alors la question du suivi de l'empaquetage.

### Exemple

* L'ordinateur du dépôt va compiler l'application pour plusieurs types de processeurs avec la rigueur nécessaire et va générer des erreurs. Votre paquet est refusé.
* L'application ne fait apparaître aucune erreur localement et le paquet que vous avez produit fonctionne très bien.
* L'erreur ou le type d'erreur est communiqué par courrier électronique.
* Ce type d'erreur vient souvent du Makefile

### Recréer l'environnement de travail

* Créer le répertoire de travail 'natif' dans l'exemple.
* Dans le répertoire natif : télécharger le fichier source à corriger, avec le navigateur, ou avec la commande wget
* Afin de faciliter l'accès à la console dans le répertoire natif, créer la commande KONSOLE qu'il faut rendre exécutable.

#### Télécharger ;

    https://launchpad.net/~jean-paul-louyot/+archive/exercises/+packages
    → mkd_0~120302-1.debian.tar.gz (3.2 KiB)
    → mkd_0~120302.orig.tar.xz (200.6 KiB)

#### Copier les fichiers dans un répertoire mkd-120302-exercice-1

    décompressez l'archive .orig.tar.gz → mkd-120302-exercice-1/mkd-0~120302 →
    décompressez l'archive .debian.tar.gz dans mkd-0~120302 → mkd-0~120302/debian

#### Éditer le fichier mkd-0~120302/Makefile et corriger
### Créer le patch

Voir le manuel des commandes unix diff, patch, quilt (ou dquilt)
Créer un patch consiste à faire la différence une diff entre un ancien et un nouveau fichier, puis de faire un patch (coller une rustine) afin de ne corriger que la partie modifiée pour mettre à jour ou pour être applicable dans d'autres conditions d'utilisation. Ceci évite de recharger tous les fichiers et de figer une application. On garde ainsi une souplesse d'utilisation.
Un patch pourrait par exemple, ne mettre à jour que des langues déjà installées.

#### Environnement de travail pour quilt
##### pour préciser où se trouvent les correctifs

    ajouter dans le ~/.bashrc export QUILT_PATCHES=debian/patches
* vérifier que l'environnement n'est pas déjà établi : cat ~/.bashrc | grep patches
* sinon echo "export QUILT_PATCHES=debian/patches" >> ~/.bashrc

#### Avant de modifier des fichiers du patch
##### Dans le répertoire natif mkd-0~120302

* vérifier qu'il n'existe pas déjà des patches : quilt applied
* créer le répertoire patch : mkdir debian/patches
* lancer la commande (dquilt pour debian) : → Le patch fix-uploads.patch est maintenant au sommet quilt new fix-uploads.patch Deux répertoire viennent d'être mis à jour ou créés depuis le répertoire courant : debian/patches et un caché .pc qui contient 'applied-patches' et un répertoire fix-uploads-patch avec le nom du patch en tête de liste, le sous répertoire fix-uploads.patch, et trois fichiers de construction cachés.
* ajouter le (ou plusieurs) fichier à modifier en tête du patch avant toute modification. Les fichiers déjà modifiés ne peuvent pas être ajoutés. quilt add Makefile. → Le fichier Makefile a été ajouté au patch fix-uploads.patch

#### Après la modification des fichiers du patch

* rafraîchir les modifications dans 'fix-uploads.patch' quilt refresh
→ Patch fix-uploads.patch rafraîchi
* valider le patch : quilt header -e fix-uploads.patch pour éditer le correctif Description : Mise en commentaire des installations conditionnelles du fichier Makefile Author: Clara <clara@mail.com> Origin: Erreur au téléversement etc. → En-tête du patch fix-uploads.patch remplacé
* voir les différences : quilt diff
    3. incrémenter la version dans changelog : dch -i "Add patch fix-uploads (Correctif de téléversement ppa Launchpad)"
    4. éditer le fichier debian/changelog et remplacer UNRELEASED par saucy
    changelog :

#### Créer et tester les paquets
##### vérifier la compilation

* vérifier que les fichiers listés dans debian/mkd.install se trouvent bien dans le répertoire ../tests/usr

##### créer les paquets locaux et on vérifie le contenu

    ls -l ..
    drwxr-xr-x 2 edeulo edeulo 4096 janv. 17 14:33 Fichiers-d'origine
    -rwx--x--x 1 edeulo edeulo 375 mars 12 2013 KONSOLE
    drwx------ 7 edeulo edeulo 4096 janv. 17 16:55 mkd-0~120302
    -rw-r--r-- 1 edeulo edeulo 3264 janv. 16 16:10 mkd_0~120302-1.debian.tar.gz
    -rw-r--r-- 1 edeulo edeulo 13030 janv. 17 16:55 mkd_0~120302-1ubuntu1_amd64.build
    -rw-r--r-- 1 edeulo edeulo 1072 janv. 17 16:55 mkd_0~120302-1ubuntu1_amd64.changes
    -rw-r--r-- 1 edeulo edeulo 176286 janv. 17 16:55 mkd_0~120302-1ubuntu1_amd64.deb
    -rw-r--r-- 1 edeulo edeulo 205384 janv. 16 15:56 mkd_0~120302.orig.tar.xz
    -rw-r--r-- 1 edeulo edeulo 2538 janv. 17 16:55 mkd-doc_0~120302-1ubuntu1_all.deb
    drwxr-xr-x 5 edeulo edeulo 4096 janv. 17 16:42 tests

##### relancer debuild -S -sa -k230B1A04

→ Successfully signed dsc and changes files
    drwxr-xr-x 2 edeulo edeulo 4096 janv. 17 14:33 Fichiers-d'origine
    -rwx--x--x 1 edeulo edeulo 375 mars 12 2013 KONSOLE
    drwx------ 7 edeulo edeulo 4096 janv. 17 17:58 mkd-0~120302
    -rw-r--r-- 1 edeulo edeulo 3264 janv. 16 16:10 mkd_0~120302-1.debian.tar.gz
    -rw-r--r-- 1 edeulo edeulo 13358 janv. 17 17:58 mkd_0~120302-1ubuntu1_amd64.build
    -rw-r--r-- 1 edeulo edeulo 1072 janv. 17 17:58 mkd_0~120302-1ubuntu1_amd64.changes
    -rw-r--r-- 1 edeulo edeulo 176286 janv. 17 17:58 rouge|mkd_0~120302-1ubuntu1_amd64.deb
    -rw-r--r-- 1 edeulo edeulo 7765 janv. 17 18:25 mkd_0~120302-1ubuntu1.debian.tar.gz
    -rw-r--r-- 1 edeulo edeulo 1514 janv. 17 18:25 mkd_0~120302-1ubuntu1.dsc
    -rw-r--r-- 1 edeulo edeulo 1755 janv. 17 18:25 mkd_0~120302-1ubuntu1_source.build
    -rw-r--r-- 1 edeulo edeulo 1839 janv. 17 18:25 mkd_0~120302-1ubuntu1_source.changes
    -rw-r--r-- 1 edeulo edeulo 205384 janv. 16 15:56 mkd_0~120302.orig.tar.xz
    -rw-r--r-- 1 edeulo edeulo 2534 janv. 17 17:58 mkd-doc_0~120302-1ubuntu1_all.deb
    drwxr-xr-x 5 edeulo edeulo 4096 janv. 17 16:42 tests

#### Tester, simuler, l'envoi au dépôt

* Vérifier le paquet dput -ol ppa:jean-paul-louyot/exercises mkd_0~120302-1ubuntu1_source.changes
* Simuler le dépôt dput -s ppa:jean-paul-louyot/exercises mkd_0~120302-1ubuntu1_source.changes
* Tenter le dépôt du paquet sur Launchpad; il peut encore y avoir un rejet.

## Mettre à jour

En cas d'échec de transfert vers un dépôt, il est souvent plus facile d'effacer le dépôt en échec et de faire une mise à jour après corrections. (Le fichier déposé ne disparaît jamais dans les listes).
On fait généralement des mises à jour d'une application en conservant le numéro de version suivi d'un tiret et d'un chiffre de version des mêmes sources.

### Exemple

    mkd-0~120508 devient mkd-0~120508-1 puis mkd-0~120508-2
En général, les sources compilables restent les mêmes. On révise, ou on ajoute, des traductions, des images, etc.

### Déroulement normal des opérations de mise à jour

Cette opération consiste à récupérer les fichiers de la version précédente. Elle devra être téléchargée du dépôt On peut aussi reprendre les fichiers locaux, mais le risque de se voir refuser un nouveau dépôt est grand. Les fichiers du dépôt ne sont pas nécessairement identiques aux fichiers locaux.

#### On récupère

* le fichier .orig.tar.gz de la version précédente Ce fichier est le même depuis la création de l'application et tout changement dans ce fichier d'origine sera refusé par le serveur de dépôt.
* le fichier .debian.tar.gz de la même version. Ce fichier contient toutes les informations pour créer une mise à jour.
* éventuellement tous les autres fichiers.
On peut faire un nouveau patch. La version ubuntu2 remplacera la version ubuntu1 sur le serveur du dépôt.

### Notre opération de mise à jour
#### Quelle mise à jour ?

* On veut ajouter les messages en langue allemande.
* On veut créer un seul fichier, car le fichier commun .all.deb n'a pas d'intérêt pour nous. Nous avons peu de documents à proposer.
* La version ? mkd (0~120302)
* Le nom du paquet ? mkd
* Le nom des paquets debian .deb ? mkd (0~120302-2)

#### Créer une nouvelle version origine sans paquet version doc

* copier l'archive version dans un répertoire mkd-120302-exercice-2/fichiers-d'origine
* copier mkd_0~120302-1ubuntu1.debian.tar.gz le décompresser dans le répertoire mkd-120302-exercice-2/fichiers-d'origine/.
* décompresser ces fichiers
* déplacer le répertoire décompressé mkd-0~120302 dans mkd-120302-exercice-2/."

   ##### Créer les nouvelles directives d'empaquetage (DEBIAN)

   * Début d'un petit fichier de travail Build exécutable :
    Options :
    -c GPL pour le copyright
    -e <email> pour l'adresse du mainteneur
    -s binaire seul
    -n natif
    -f <fichier> fichier d'origine
    -p <version> version de paquet

#### Mise à jour des fichiers du répertoire source

Ajouter les fichiers de langue mkd_de.mo et mkd_de.1.gz dans le répertoire 'lang'

##### Modifier le Makefile

* Remplacer le Makefile par celui de l'exercice-1
* Éditer le Makefile
* Supprimer les lignes de commentaires inutiles
* Ajouter les lignes d'installation de la langue allemande

##### Valider les modifications par un examen du fichier des tests

Vérifier que tout est en ordre et que la langue allemande est bien à sa place

##### Ajouter un fichier README-INSTALL
#### Mise à jour du répertoire debian
##### Commencer par mettre ce répertoire à jour

* le supprimer dans le répertoire des sources
* Relancer la commande Build (dans le répertoire de l'exercice)
* Entrer dans le répertoire debian
* Éditer le fichier changelog et remplacer mkd (0~120302-1) unstable par """mkd (0~120302-2) saucy. La version courante de linux ubuntu est saucy en janvier 2014. Supprimer ce qui suit Initial release
* Éditer le fichier control et remplacer unknown à la ligne Section par devel. Pour le reste, se reporter à l'exercice précédent
    6. Éditer le fichier copyright et remplacer la ligne Source: par
Source: http://edeulo.free.fr/pub/Packaging-exercises/mkd-120302-exercice-2.tar.xz Puis recopier le reste de Files: * ... jusqu'à la fin.
    7. Vérifier que le fichier doc contienne bien 'README-INSTALL'
    8. Supprimer tous les fichiers .ex, .EX; et README.*
    9. Copier les fichiers postinst et postrm de l'exercice précédent. puisque rien n'a changé ...

##### Contenu du répertoire debian après mise à jour

    -rw-r--r-- 1 edeulo edeulo 128 janv. 20 15:36 changelog
    -rw-r--r-- 1 edeulo edeulo 2 janv. 20 15:26 compat
    -rw-r--r-- 1 edeulo edeulo 696 janv. 20 15:36 control
    -rw-r--r-- 1 edeulo edeulo 1394 janv. 20 15:26 copyright
    -rw-r--r-- 1 edeulo edeulo 34 janv. 20 15:26 docs
    -rw-r--r-- 1 edeulo edeulo 1285 janv. 13 10:43 postinst
    -rw-r--r-- 1 edeulo edeulo 1092 janv. 13 10:41 postrm
    -rwxr-xr-x 1 edeulo edeulo 442 janv. 20 15:26 rules
    drwxr-xr-x 2 edeulo edeulo 4096 janv. 20 15:26 source

#### Créer, vérifier, et tester les fichiers de transfert au dépôt

Les fichiers nécessaires au transfert ont été créés sans erreur
* Vérifier le paquet dput -ol ppa:jean-paul-louyot/exercises mkd_0~120302-2_source.changes
Good signature on /home/edeulo/Packaging/mkd/mkd_12XXXX/mkd-120302-exercice-2/mkd_0~120302-2.dsc. Package includes an .orig.tar.gz file although the debian revision suggests that it might not be required. Multiple uploads of the .orig.tar.gz may be rejected by the upload queue management software.
* Simuler le dépôt dput -s ppa:jean-paul-louyot/exercises mkd_0~120302-2_source.changes
Même message d'avertissement : Peut être refusé par la file d'attente de téléchargement
* Tenter malgré tout le dépôt du paquet sur Launchpad :
On peut s'attendre à avoir un rejet.

## Nouvelle version

Dans tous les exercice précédents, le seul but était d'apprendre à créer des paquets et à les envoyer en dépôt sur le serveur Launchpad.
Or notre application se veut universelle compilable sur tous les systèmes Unix, Linux, et accessoirement sous d'autres systèmes tels que MS-Windows ou Mac. L'application se compile en ligne de commande à l'aide d'un Makefile ou un shell de commandes install (install.sh, install.bat)
Les paquets sont agréables à installer. L'idée est donc de créer des paquets debian avec un original contenant des sources compilables sur tous les systèmes d'exploitation, pour n'importe quelle machine, quel que soit son processeur.
Pour ce faire, nous allons transposer tout le répertoires des sources dans un répertoire d'origine/sources et créer un Makefile spécialisé pour la construction de paquets. Nous devrons aussi donner un maximum de renseignements pour installer l'application sur d'autres machines.

#### Créer le nouvel environnement de travail

* Créer les répertoire contenant l'ensemble des éléments de travail mkdir mkd-120515-exercice-3 mkd-120515-exercice-3/mkd-120515
* Copier dans ce répertoire les utilitaires KONSOLE et Build de l'exercice précédent.
* Copier mkd_0~120302.orig.tar.xz de l'exercice-0 dans le répertoire mkd-120515
* Décompacter mkd_0~120302.orig.tar.xz et renommer src le répertoire décompacté.
* Entrer dans le répertoire src et lancer la commande : make -d install DESTDIR=../.
Cette commande va créer les répertoires utiles à la fabrication des paquets.
* Vérifier le contenu du répertoire mkd-120515/usr
On voit qu'il y manque la langue allemande pour les messages et le manuel

#### Créer le Makefile d'empaquetage

* Seul le binaire usr/bin/mkd doit être mis à jour pour les différents processeurs

##### Il faut donc

* précompiler tous les fichiers d'accompagnement de l'application (langues, icônes, etc.),
* mettre le binaire mkd à jour pour chaque processeur par le serveur Launchpad.

##### Construction du Makefile à l'aide du Makefile des sources

* vérifier que usr/bin/mkd est mis à jour : (heure de compilation actualisée)

#### Créer les conditions d'empaquetage debian avec dh_make
##### Modifier les fichiers comme dans les exercices précédents

debian/changelog
debian/control
debian/copyright
debian/docs
debian/README

##### Ajouter le fichier README-INSTALL dans le répertoire origine mkd-120515

et README-INSTALL.pdf de l'exercice précédent :
README-INSTALL

#### Créer le paquet local

Dans le répertoire origine :
Relisant le fichier créé :mkd_120515_amd64.deb avec le gestionnaire d'archives on s'aperçoit que l'on a oublié la langue allemande :
* copier les fichiers mkd-de.1.gz et mkd_de.mo dans src/lang
* ajouter cp -f lang/mkd_de.mo $(LANG)/de/LC_MESSAGES/mkd.mo dans src/Makefiles (ligne ±69)
* ajouter install -D -m644 lang/mkd_de.1.gz $(MAN)/de/man1/mkd.1.gz dans src/Makefile (ligne ±75)
* relancer make -d install DESTDIR=../. dans le répertoire src
* contrôler que la langue allemande est maintenant présente
       ./share/man/fr.UTF-8/man1/mkd.1.gz
       ./share/man/de/man1/mkd.1.gz
       ./share/man/man1/mkd.1.gz
       ./share/locale/fr/LC_MESSAGES/mkd.mo
       ./share/locale/en/LC_MESSAGES/mkd.mo
       ./share/locale/de/LC_MESSAGES/mkd.mo

##### Tout reconstruire

    Build

#### Préparer l'envoi au dépôt Launchpad

* Créer les fichiers pour Launchpad
Éditer et vérifier les fichiers : mkd_120515_source.build, mkd_120515_source.changes, mkd_120515.dsc
* Vérifier le paquet
* Simuler le dépôt
* Tenter le dépôt du paquet sur Launchpad :

## Dépôt sur Launchpad

Pour déposer un paquet il faut disposer d'un compte de dépôt (PPA) et d'une clé PGP avec GnuPG

### Création d'un dépôt pour les exercices

    Pour la démonstration on a créé un nouvel espace :
       Dans le ppa:jean-paul-louyot, on a créé le répertoire exercises avec le nouveau ppa Do a package
       https://launchpad.net/~jean-paul-louyot/+archive/exercises

### Launchpad - Premier exercice : ITP mkd_0~120302-1
#### La commande

    dput ppa:jean-paul-louyot/exercises mkd_0~120302-1_source.changes
    a correctement téléversé les fichiers suivants :
Si vous vous êtes trompé dans l'envoi vous trouverez le fichier .upload qu'il faudra supprimer si vous désirez faire un nouvel envoi.

   #### Réception du courrier après build
   #### Édition du fichier Build Log _FAILEDTOBUILD.txt.gz

La construction des paquets s'est donc arrêtée faute de trouver le fichier mkd.1.gz. La construction de notre paquet local n'a pas généré d'erreur et le répetoire des tests que nous avons utilisé pour créer le fichier mkd.install montre bien le fichier mkd.1.gz dans le bon répertoire.

   #### Pourquoi ça n'a pas fonctionné alors que le répertoire debian/tmp a bien été créé

Pour cela il faut pour cela relire la compilation dans _FAILEDTOBUILD.txt.gz :
On voit que la condition d'installation du fichier mkd.1.gz dépend de la machine sur laquelle on va effectuer la compilation.
    Il est impératif d'éliminer les compilations conditionnelles

   #### On peut installer

* des fichiers, sans avoir recours à une copie conditionnelle.
* les fichiers dans un répertoire déterminé (là où il sera installé avec le paquet). En cas de nécessité, on pourra déplacer ces fichiers par un script dans debian/post-install.

#### Reconstruction du paquet par modification du Makefile.
### Launchpad - Deuxième exercice : Patch mkd_0~120302-1ubuntu1
#### Consultation du dépôt

    https://launchpad.net/~jean-paul-louyot/+archive/exercises
    La version n'apparaît pas, on peut donc refaire le fichier _sources.changes avec une bonne signature :

#### Lecture du fichier _sources.changes.clear

    ligne 9 : Maintainer: Edeulo <edeulo@free.fr>
    ligne 10 : Changed-By: Edeulo <edeulo@jpl-ubuntu-13.04>

#### Modifier le fichier debian/changelog

    ligne 5 :
    — -- Edeulo <edeulo@jpl-ubuntu-13.04> Fri, 17 Jan 2014 15:05:36 +0100
    + -- Edeulo <edeulo@free.fr> Fri, 17 Jan 2014 15:05:36 +0100

#### Recommencer

* debuild -S -sa -k230B1A04 dans le répertoire dorigine, et vérifier que le fichier _source.changes est bien correctement modifié,
* déplacer ou supprimer mkd_0~120302-1ubuntu1_source.ppa.upload pour qu'il n'y ait pas une nouvelle erreur de transfert.
* dput ppa:jean-paul-louyot/exercises mkd_0~120302-1ubuntu1_source.changes au dessus du répertoire d'origine.
* Voir les fichiers compilés et empaquetés après un temps d'attente variable en fonction du nombre de paquets en instance ...

#### Remarques

* L'archive debian mkd_0~120302-1ubuntu1.debian.tar.gz, contient maintenant , en plus de sa propre archive debian, une archive icon dans laquelle on retrouve l'ancienne archive mkd_0~120302-1.debian.tar.gz → debian habituel + incons/mkd_0~120302-1.debian.tar.gz ajouté
* Le répertoire debian contient maintenant, en plus du fichier format, le fichier includes-binaries avec le texte "icons/mkd_0~120302-1.debian.tar.gz"
* Sur Launchpad : Le nouveau dépôt, avec le patch, a remplacé celui qui avait échoué.

### Launchpad - Troisième exercice : Mettre à jour
#### Réponse par courriel

Les fichiers ont été acceptés. Pas de problème pour les sommes de contrôle; mais la compilation ?

#### Réponse du serveur

    Tout le monde a faux !
La nouvelle version 0~120302-2 remplace la version 0~120302-1ubuntu1 avec une différence de 3,8Kilo-Bytes Le serveur Launchpad a répondu Erreur de compilation pour amd64 et Compilation copmplète pour i386
Dans https://launchpad.net/~jean-paul-louyot/+archive/exercises/+build/5484224 on a la possibilité de recompiler la version amd64
    [FAILEDTOBUILD] Failed to build Retry this build
    Recompilation correcte pour amd64

### Launchpad - Quatrième exercice : Nouvelle version

→ Retour par courriel :

#### Consultation du dépôt

https://launchpad.net/~jean-paul-louyot/+archive/exercises/+copy-packages → résulat :

## Résumés, notes et références
### Résumés des solutions
#### Exercice-0 Intention d'empaqueter
##### On y apprend à

* modifier le fichier Makefile de l'application d'origine,
* créer des paquets multiples et à modifier les fichiers du répertoire debian, en particulier pour les paquets multiples,
* préparer les fichiers nécessaires à un dépôt sur Launchpad
* déposer sur Launchpad une application testée et sécurisée par une clé personnelle
* trouver les raisons de l'échec au dépôt
* renvoyer les fichiers corrigés après une erreur de compilations sur Launchpad

#### Exercice-1 Patch (rustine)
##### On y apprend à

* créer les conditions de travail dans l'environnement utilisateur : QUILT_PATCHES,
* créer un patch avec quilt et ajouter les fichiers bogués au patch,
* modifier les fichiers bogués et rafraîchir le patch
* contrôler et modifier le fichier debian/changelog
* créer les nouveaux paquets
* mettre les modifications à jour avec dpkg-source --commit, et créer les fichiers de transfert sécurisés,
* préparer les fichiers nécessaires à un dépôt sur Launchpad,
* modifier une signature de clé erronée sans changer le checksum du fichier d'origine,
* renvoyer le fichier -source.changes et contrôler les applications déposées

#### Exercice-2 Mettre à jour
##### On y apprend à

* à créer une nouvelle version origine (Sans le paquet doc. La version remplacera la précédente sur le dépôt)
** Ajouter des fichiers dans le répertoire source (Langues et README-INSTALL)
** (Makefile) Recréer les conditions de compilation adaptées à ces nouveaux fichiers, sans passer par un patch.
** Adapter les fichiers du répertoire debian pour une version binaire simple
* Créer les conditions de transfert comme dans les exercices précédents
* Relancer la compilation d'une version partiellement en échec

#### Exercice-3 Nouvelle version

* Création d'un paquet natif
* Simplification du répertoire d'origine
* Simplification du Makefile d'installation

### Notes
#### Téléchargement des exercices

* Exercice-0 Intention d'empaqueter mkd-120302-exercice-0.tar.xz
* Exercice-1 Patch (rustine) mkd-120302-exercice-1.tar.xz
* Exercice-2 Mettre à jour mkd-120302-exercice-2.tar.xz
* Exercice-3 Nouvelle version mkd-120515-exercice-3.tar.xz

#### Voir aussi

* L'exemple très simple de mise en paquet Debian pour la maintenance logicielle
* La mise en paquet avec DCBS
* Un exemple de menu : debian/menu et usr/share/applications/mkdcppw.desktop dans l'archive mkdcppw_140201.tar.gz → Le paquet menu n'existe plus dans les versions récentes d'Ubuntu. Cependant il est possible d'ajouter une application manuellement en suivant cet exemple.

### Références

* ↑ Pré-requis
* ↑ Versions d'Ubuntu
* ↑ Fichier control
* ↑ Sections Ubuntu
* ↑ Exemple de menu dans mkdcppw

# Codes QR des téléchargements

Cette page est susceptible de subir des modifications occasionnelles
Les codes QR (Quick Response) permettent aux lecteurs des pages imprimées de se connecter rapidement sur le wikilivre à l'aide d'un lecteur de codes QR (disponible sur les smartphones) pour:
    recompiler le livre sous une forme différente ou obtenir une version à jour,
    compiler d'autres pages.
* Article wikibook Mkd Extracteur de documents
* Compilation La commande mkd avec QR des téléchargements
* Compilation pour ePub Exercices avec mkd, avec les réponses aux exercices
* Compilation:Extracteur de documents mkd avec Exercices et QR des téléchargements
* Packs mkd sources + binaires Ubuntu (i386+amd64) Téléchargement
* Packs mkdcppw sources + binaires Ubuntu (i386+amd64) Téléchargement
* mkd Windows Beta 2010 (x86) Téléchargement Lien à corriger

# NOTES ET ANNEXES
## Notes

Notes Icônes des fichiers et applications héritées

## Note sur les icônes sous linux

* Lorsque vous installez mkd ou mkdcppw, les icônes des fichiers de projets d'extension .pj et .prj facilitent leur repérage visuel.
* Les extensions de fichiers .pj et .prj ne sont pas obligatoires pour les fichiers de projets mais facilitent leur reconnaissance avec l'option -j.

## Note sur les applications périphériques de mkd

Les modules de fonctions sont évidemment utilisables dans d'autres applications:
* La commande mkdcpp a été créée pour éprouver la fonction cpp_ et pour évaluer une nouvelle ligne de commande avec les tiret moins et moins-moins. [-Codes (5*ASCII)], --[Options (nst)]
    Cette application utilise le module cpp.c
* La commande mkdasm a été créé dans le même esprit que l'application mkdcpp.
    Cette application utilise le module asm.c
* L'application mkdcppw a été créée sous linux pour évaluer la faisabilité d'une version fenêtrée avec, en fin de processus, une fenêtre d'impression au format UTF-8.
    Cette application utilise le module cpp.c et est composée de nouveaux modules, notamment pour tester le codage des caractères UTF-8 dans les textes.
* Une icône de l'application mkdcppw est visible dans la barre des tâches lorsque cette application est active.

## ANNEXES ET LIENS

1.mkd-Manuel (fr)
    https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/mkd-Manuel_(fr)
2.mkddocu-Manuel (fr)
    https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/mkddocu-Manuel_(fr)
3.Compilations de wiki-livres
    https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Compilations
6.Licences
    https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/Licences