star-style

Writing conventions for co-authors
Log | Files | Refs | README | LICENSE

commit 2e28c11da06095986e2530453a484dae81b7a7d2
parent ebb30c1cd2765d5744bf0e0431d8d8bb854a80f0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Mon, 13 Jul 2026 17:28:03 +0200

Supprime les espaces insécables fins

Les remplacer par des espaces insécables classiques. Sinon, la
conversion PDF via mandoc affiche un caractère <?> à chaque espace
insécable fin, signe que le caractère ne serait pas reconnu (?).

Diffstat:
Mdoc/fr/star-c.7 | 58+++++++++++++++++++++++++++++-----------------------------
1 file changed, 29 insertions(+), 29 deletions(-)

diff --git a/doc/fr/star-c.7 b/doc/fr/star-c.7 @@ -2,18 +2,18 @@ .\" .\" Ce fichier fait partie de Star-Style .\" -.\" Star-Style est un logiciel libre ; vous pouvez le redistribuer ou le +.\" Star-Style est un logiciel libre ; vous pouvez le redistribuer ou le .\" modifier suivant les termes de la GNU General Public License telle -.\" que publiée par la Free Software Foundation ; soit la version 3 de +.\" que publiée par la Free Software Foundation ; soit la version 3 de .\" la licence, soit (à votre gré) toute version ultérieure. .\" .\" Star-Style est distribué dans l'espoir qu'il sera utile, mais SANS -.\" AUCUNE GARANTIE ; sans même la garantie tacite de QUALITÉ MARCHANDE +.\" AUCUNE GARANTIE ; sans même la garantie tacite de QUALITÉ MARCHANDE .\" ou d'ADÉQUATION à UN BUT PARTICULIER. Consultez la GNU General .\" Public License pour plus de détails. .\" .\" Vous devez avoir reçu une copie de la GNU General Public License en -.\" même temps que Star-Style ; si ce n'est pas le cas, consultez +.\" même temps que Star-Style ; si ce n'est pas le cas, consultez .\" <http://www.gnu.org/licenses>. .Dd July 13, 2026 .Dt STAR-C 7 @@ -28,7 +28,7 @@ Ce document décrit les conventions d'écriture des programmes C distribués par |Méso|Star>. Ces recommandations sont données à titre indicatif, et reste subordonnées aux pratiques effectivement retenues dans chaque -projet ; le plus important étant d'en conserver la cohérence. +projet ; le plus important étant d'en conserver la cohérence. Si bien que s'il appartient aux co-auteurs d'un projet de prendre certaines libertés quant à ce guide de style, toute participation à son développement devra alors s'efforcer de respecter le style d'écriture du @@ -66,18 +66,18 @@ Avec : .Bl -dash -compact .It .Pa README.md -le fichier qui donne le premier niveau d'informations sur le projet ; +le fichier qui donne le premier niveau d'informations sur le projet ; .It .Pa COPYING -la license du projet qui liste ses conditions légales d'utilisation ; +la license du projet qui liste ses conditions légales d'utilisation ; .It .Pa config.mk et .Pa Makefile -les fichiers du système de génération automatique ; +les fichiers du système de génération automatique ; .It .Pa src/ -le répertoire qui contient les codes source du projet ; +le répertoire qui contient les codes source du projet ; .It .Pa doc/ le répertoire qui stocke sa documentation. @@ -118,7 +118,7 @@ pour une description exhaustive des macros utilisées pour activer le jeu de fonctionnalités d'un standard donné. .Pp L'utilisation d'un C enrichi du standard POSIX n'est ainsi utilisé que -sur les seuls fichiers qui en explicite le besoin ; le C89 restant le +sur les seuls fichiers qui en explicite le besoin ; le C89 restant le langage utilisé partout ailleurs. Dans un même souci de portabilité, retenir la première version du standard POSIX à partir de laquelle la fonctionnalité recherchée est @@ -139,13 +139,13 @@ Ci-après sont listées les différentes parties d'un fichier source : Un commentaire avec l'avis de copyright et les avis de licence du programme .Pq section Sx L'AVIS DE COPYRIGHT ET LES AVIS DE LICENCE Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It La définition d'une macro qui ajoute au langage C du fichier le support d'un standard POSIX .Pq section Sx LE LANGAGE C Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It Pour un fichier d'en-tête, l'ouverture d'un garde-fou évitant sa double @@ -173,15 +173,15 @@ macro .It L'inclusion des fichiers d'en-tête requis par le fichier source ; .Pq section Sx LES FICHIERS D'EN-TÊTE Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It La définition des macros .Pq section Sx LES MACROS Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It -La déclaration anticipée des types structurés : +La déclaration anticipée des types structurés : .Bd -literal -offset Ds /* Type structurés externes au programme */ struct plugh; @@ -197,23 +197,23 @@ struct foo; La définition des constantes symboliques de type .Vt enum .Pq section Sx LES CONSTANTES SYMBOLIQUES Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It La définition des types structurés et de leur(s) constante(s) .Pq section Sx LES STRUCTURES Ns - ; + ; .\"""""""""""""""""""""""""""""""""" .It La déclaration et définition des fonctions .Pq section Sx LES FONCTIONS . -Dans l'ordre qui suit : +Dans l'ordre qui suit : .Pp .Bl -tag -compact -width a. .It a. -la déclaration des fonctions ; +la déclaration des fonctions ; .It b. -la définition des fonctions statiques ; +la définition des fonctions statiques ; .It c. pour les unités de compilation, la définition des fonctions. .El @@ -294,7 +294,7 @@ est : * * You should have received a copy of the GNU General Public * License along with Foo. If not, see - * <https://www.gnu.org/licenses/>. */ + * <https://www.gnu.org/licenses/>. */ .Ed .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh L'INDENTATION @@ -435,9 +435,9 @@ commentaires sur une ligne séparée : Inclure les fichiers d'en-tête dans l'ordre qui suit : .Bl -enum -compact .It -les en-têtes locaux au programme ; +les en-têtes locaux au programme ; .It -les en-têtes des dépendances du programme ; +les en-têtes des dépendances du programme ; .It les en-têtes systèmes et ceux de la bibliothèque C standard. .El @@ -467,7 +467,7 @@ est inclus. .Ed .Pp S'efforcer de n'inclure que les seuls fichiers d'en-tête -réellement nécessaires au fichier ; +réellement nécessaires au fichier ; par exemple par une déclaration anticipée des types structurés à la place d'inclure des en-têtes dans le seul but de déclarer lesdits types. @@ -517,7 +517,7 @@ option .Fl DFOO_SHARED_BUILD du compilateur C .Pc Ns - ; + ; .It .Sy EXPORT_SYM et @@ -746,7 +746,7 @@ for (;;) { /* Boucle infinie */ .Pp Assimiler l'instruction .Ql sizeof -à une fonction ; ne pas insérer d'espace entre le mot clé et son +à une fonction ; ne pas insérer d'espace entre le mot clé et son expression entourée de parenthèses : .Bd -literal -offset Ds sz = sizeof(int); @@ -846,7 +846,7 @@ pour un indice .Va i ou un nombre d'éléments .Va n Ns - ; leur contexte d'utilisation venant préciser ce que leur nom résume. + ; leur contexte d'utilisation venant préciser ce que leur nom résume. Ce nom abrégé vient non seulement alléger l'écriture mais aussi en renforcer l'expressivité. Par exemple @@ -971,7 +971,7 @@ Par exemple, pour la bibliothèque .Pp Utiliser la convention typographique dite .Dq camel case -pour nommer les arguments des macros ; +pour nommer les arguments des macros ; les termes qui composent leur nom sont séparés par une variation de la casse typographique. Un terme débute par une majuscule, suivi de caractères @@ -1149,7 +1149,7 @@ initialisés. Si elle existe, utiliser la constante proposée avec la structure pour initialiser une variable de ce type. .Pq voir section Sx LES CONSTANTES . -En son absence n'initialiser que le premier membre de la variable ; le +En son absence n'initialiser que le premier membre de la variable ; le language C assure alors que les autres membres seront initialisés à 0. De même pour un tableau alloué sur la pile, initialiser son premier élément suffit à garantir que le reste du tableau sera initialisé à