Chapitre 43. Conventions de codage pour PostgreSQL

Table des matières
43.1. Formatage
43.2. Reporter les erreurs dans le serveur
43.3. Guide de style des messages d'erreurs
43.3.1. Ce qui va où
43.3.2. Formatage
43.3.3. Guillemets
43.3.4. Utilisation des guillemets
43.3.5. Grammaire et ponctuation
43.3.6. Majuscule contre minuscule
43.3.7. Éviter la voix passive
43.3.8. Présent contre passé
43.3.9. Type de l'objet
43.3.10. Crochets
43.3.11. Assembler les messages d'erreurs
43.3.12. Raisons pour les erreurs
43.3.13. Nom des fonctions
43.3.14. Mots délicats à éviter
43.3.15. Orthographe appropriée
43.3.16. Adaptation linguistique

43.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.