Ok sur toute la ligne pour moi :-)

Question :

Est-ce que Ncooker check verifie qu'il y ait au moins un summary et
description
courte en anglais, ou le fichier desc peut-etre vide ? Est-ce que seul le
summary est obligatoire ? Est-ce que si je fournis un summary pour une langue
je dois egalement fournir une longue description ?

A ces questions je propose la chose suivante :
Seul le summary en anglais est obligatoire (cad non vide0. Parce qu'il arrive
souvent que la description ne depasse pas 80 characteres

++
Chicha


Quoting Gontran Baerts <[EMAIL PROTECTED]>:


Salut à tous,

Après avoir remanié le fichier infos, voici quelques propositions pour le
fichier desc.

Le format actuel du fichier desc imposent plusieurs contraintes :

1 - avoir des lignes de textes limitées à 50 caractères, dont la longueur est
indiquée par la ligne #=========#=========#=========#=========#=========

2 - commencer chaque ligne de la description longue par %LD[xx].

Ouvrez un fichier desc, ce sera plus clair si nécessaire ;^)

La contrainte 1 oblige le nbuilder à faire attention au format de son texte.
Cette contrainte a été imposée, je crois, pour Nsetup. Celui-ci affiche les
descriptions courte et longue de chaque paquet en cours d'installation dans
une « fenêtre texte » qui autorise un affichage maximum de 50 caractères par
ligne.

La contrainte 2 est, de ma propre expérience, assez lourde, notamment
lorsqu'on fait un copier/coller d'une description trouvée sur le site web du
soft nbuildé : il faut retravailler le copié/collé ligne par ligne, d'une
part pour ajouter un %LD[xx] au début, d'autre part pour couper les lignes au
bout de 50 caractères.

J'aimerais supprimer ces contraintes de telle manière que le nbuilder puisse
se concentrer sur le contenu de ces deux descriptions sans se soucier de leur
mise en forme.

Dans une moindre mesure, je trouve aussi que les mots-clés SD et LD ne sont
pas très parlant, même si avec l'expérience, je sais qu'il s'agit de Short
Description et Long Description. Ce que je veux dire, c'est que pour un
néophyte qui consulte les fichiers d'un NBUILD, leur signification ne saute
pas obligatoirement aux yeux.

Fort de ces remarques, je propose de modifier le format de la manière
suivante :

- remplacer « %SD[xx]<tab> » par « %Summary[xx]: », et commencer la
description courte sur la ligne qui suit ce mot-clef.

- remplacer « %LD[xx]<tab> » par « %Description[xx]: », et commencer la
description longue sur la ligne qui suit ce mot-clef.

Exemple :

«
%Summary[en]:
Shell developed by the GNU Project.

%Summary[fr]:
Interprêteur de commande développé par le Projet GNU.

%Description[fr]:
Bash est un super interprêteur de commandes développés par le projet GNU, qui
sert aussi à écrire des scripts shell assez puissant.

D'ailleurs, Nasgaia l'utilise pour développer son gestionnaire de paquets
Ncooker.

C'est dire ! :-)

%Description[en]:
Bash is a great shell developped by the GNU Project, allowing to code
powerful
shell scripts too.

The Nasgaïa Project uses it to develop its package manager Ncooker.

Good example ! :-)
»

La casse utilisée pour les mots-clés importe peu (minuscules/majuscules). Le
nbuilder peut utiliser indifféremment %Summary, %summary, %SUMMARY ou
%SuMmArY.

Chaque description commence à la ligne suivant un mot-clé et se termine à la
ligne précédant le mot-clé suivant ou à la fin du fichier.

L'ordre des mots-clés importe peu : dans mon exemple, j'ai regroupé les
summaries ensemble et les descriptions ensemble. Mais on pourrait aussi bien
regrouper par langue.

La longueur des lignes importe peu ... MAIS :^) je propose que le summary ne
dépasse pas 80 caractères au total (soit 1 ligne de texte normale), et que la
description ne dépasse pas 800 caractères au total (soit 10 lignes de texte
normales). Donc :

«
%Summary[en]:
Shell developed
by the GNU
Project.
»

est valable car les trois lignes de description mises bout à bout ne
dépassent
pas 80 caractères. Par contre, Ncooker affichera la description sur toute la
largeur de la console/terminal, indépendamment de la mise en forme utilisée
dans le fichier desc.

Les summaries/descriptions en eux-même peuvent contenir n'importe quel
caractère, des lignes vides, des tabulations, etc.

Par contre, je propose de ne pas utiliser le nom du paquet dans le
summary. Ça
forcera le nbuilder a écrire un « vrai » summary semblable à une définition.
C'est contrainte est importante, car un petit coup de « grep » sur les
NBUILDs fournis avec Nasgaia 1.0.1 a montré que la grande majorité d'entre
eux ont comme decription courte leur propre nom !!! :

...
SYSTEM/findutils-4.1.tar:%SD[fr]        Findutils de GNU
SYSTEM/findutils-4.1.tar:%SD[en]        GNU findutils
SYSTEM/textutils-2.1.tar:%SD[fr]        GNU textutils
SYSTEM/textutils-2.1.tar:%SD[en]        GNU textutils
SYSTEM/psmisc-21.3.tar:%SD[fr]  psmisc
SYSTEM/psmisc-21.3.tar:%SD[en]  psmic
SYSTEM/util-linux-2.11z.tar:%SD[fr]     util-linux
SYSTEM/util-linux-2.11z.tar:%SD[en]     util-linux
SYSTEM/procps-3.1.11.tar:%SD[fr]        procps
SYSTEM/procps-3.1.11.tar:%SD[en]        procps
SYSTEM/pkgconfig-0.15.0.tar:%SD[fr]     pkg-config
SYSTEM/pkgconfig-0.15.0.tar:%SD[en]     pkg-config
SYSTEM/inetutils-1.4.2.tar:%SD[fr]      inetutils
SYSTEM/inetutils-1.4.2.tar:%SD[en]      inetutils
...

Quel est l'intérêt de mettre une description courte ou même de gérer une
traduction en plusieurs langues dans ce cas ? aucune ! :^)

Voilà ...
Toutes ces vérifications seraient faites par « Ncooker check ».
Pour ce qui est du parsing du nouveau format, une simple commande sed suffit
pour récupérer le summary ou la description voulue, donc c'est pas un pb.
Et bien sûr, l'outil « convert » serait modifié pour convertir
automatiquement
le fichier desc de l'ancien vers le nouveau format.

vos avis ? :^)

Gontran

_______________________________________________
Nasgaia-dev mailing list
[email protected]
https://mail.gna.org/listinfo/nasgaia-dev




Répondre à