Chapitre 45. Conventions de codage pour PostgreSQL

Table des mati�res
45.1. Formatage
45.2. Reporter les erreurs dans le serveur
45.3. Guide de style des messages d'erreurs
45.3.1. Ce qui va o�
45.3.2. Formatage
45.3.3. Guillemets
45.3.4. Utilisation des guillemets
45.3.5. Grammaire et ponctuation
45.3.6. Majuscule contre minuscule
45.3.7. �viter la voix passive
45.3.8. Pr�sent contre pass�
45.3.9. Type de l'objet
45.3.10. Crochets
45.3.11. Assembler les messages d'erreurs
45.3.12. Raisons pour les erreurs
45.3.13. Nom des fonctions
45.3.14. Mots d�licats � �viter
45.3.15. Orthographe appropri�e
45.3.16. Adaptation linguistique

45.1. Formatage

Le formatage du code source utilise un espacement de quatre colonnes pour les tabulations, avec la pr�servation de celles-ci (c'est-�-dire que les tabulations ne sont pas converties en espaces). Chaque niveau logique d'indentation est une tabulation suppl�mentaire. Les r�gles de disposition (positionnement des parenth�ses, etc) suivent les conventions BSD.

Bien que les correctifs (patchs) soumis ne sont absolument pas tenus de suivre ces r�gles de formatage, il est recommand� de le faire. Votre code sera pass� dans pgindent, donc il n'y a pas d'int�r�ts � ce qu'il soit joli gr�ce � d'autres ensembles de conventions de formatage.

Pour Emacs, ajoutez ce qui suit (ou quelque chose de semblable) � votre fichier d'initialisation ~/.emacs :

;; v�rification des fichiers avec un chemin contenant "postgres" ou "pgsql"
(setq auto-mode-alist
  (cons '("\\(postgres\\|pgsql\\).*\\.[ch]\\'" . pgsql-c-mode)
        auto-mode-alist))
(setq auto-mode-alist
  (cons '("\\(postgres\\|pgsql\\).*\\.cc\\'" . pgsql-c-mode)
        auto-mode-alist))

(defun pgsql-c-mode ()
  ;; Configuration du formatage pour le code C de PostgreSQL
  (interactive)
  (c-mode)
  (setq-default tab-width 4)
  (c-set-style "bsd")             ; positionner c-basic-offset � 4, plus d'autres choses
  (c-set-offset 'case-label '+)   ; ajuste l'indentation de la casse pour correspondre aux usages de PG
  (setq indent-tabs-mode t))      ; pour �tre s�r que nous gardons les tabulations en indentant

Pour vi, votre ~/.vimrc ou le fichier �quivalent devrait contenir ce qui suit :

set tabstop=4

ou d'une mani�re �quivalente, dans vi, essayez

:set ts=4

Les outils de parcours de texte more et less peuvent �tre appel�s de la mani�re suivante

more -x4
less -x4

pour qu'ils affichent correctement les tabulations.