Update Emacs/vim editor info.
This commit is contained in:
parent
c84db61c08
commit
8dc8f44f58
@ -370,7 +370,7 @@
|
||||
less:
|
||||
less -x4
|
||||
</PRE>
|
||||
<P>The <I>tools</I> directory of the latest sources contains sample
|
||||
<P>The <I>tools/editors</I> directory of the latest sources contains sample
|
||||
settings that can be used with the <I>emacs, xemacs</I> and <I>vim</I>
|
||||
editors, that assist in keeping to PostgreSQL coding standards.
|
||||
</P>
|
||||
|
@ -1,4 +1,4 @@
|
||||
<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.17 2006/03/10 19:10:49 momjian Exp $ -->
|
||||
<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.18 2006/09/07 00:10:46 momjian Exp $ -->
|
||||
|
||||
<chapter id="source">
|
||||
<title>PostgreSQL Coding Conventions</title>
|
||||
@ -21,44 +21,11 @@
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For <productname>Emacs</productname>, add the following (or
|
||||
something similar) to your <filename>~/.emacs</filename>
|
||||
initialization file:
|
||||
|
||||
<programlisting>
|
||||
;; check for files with a path containing "postgres" or "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 ()
|
||||
;; sets up formatting for PostgreSQL C code
|
||||
(interactive)
|
||||
(c-mode)
|
||||
(setq-default tab-width 4)
|
||||
(c-set-style "bsd") ; set c-basic-offset to 4, plus other stuff
|
||||
(c-set-offset 'case-label '+) ; tweak case indent to match PG custom
|
||||
(setq indent-tabs-mode t)) ; make sure we keep tabs when indenting
|
||||
</programlisting>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For <application>vi</application>, your
|
||||
<filename>~/.vimrc</filename> or equivalent file should contain
|
||||
the following:
|
||||
|
||||
<programlisting>
|
||||
set tabstop=4
|
||||
</programlisting>
|
||||
|
||||
or equivalently from within <application>vi</application>, try
|
||||
|
||||
<programlisting>
|
||||
:set ts=4
|
||||
</programlisting>
|
||||
The <filename>src/tools</filename> directory contains sample settings
|
||||
files that can be used with the <productname>emacs</productname>,
|
||||
<productname>xemacs</productname> or <productname>vim</productname>
|
||||
editors to help ensure that they format code according to these
|
||||
conventions.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
78
src/tools/editors/emacs.samples
Normal file
78
src/tools/editors/emacs.samples
Normal file
@ -0,0 +1,78 @@
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
;;;
|
||||
;;; This file contains several examples of how to set up emacs and/or xemacs
|
||||
;;; to edit PostgreSQL code.
|
||||
;;;
|
||||
;;; Whichever set you choose would go in your .emacs file or equivalent.
|
||||
;;;
|
||||
;;; You only need one of these.
|
||||
;;;
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
;;; This set is known to work with old versions of emacs
|
||||
|
||||
(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 ()
|
||||
;; sets up formatting for PostgreSQL C code
|
||||
(interactive)
|
||||
(c-mode)
|
||||
(setq-default tab-width 4)
|
||||
(c-set-style "bsd") ; set c-basic-offset to 4, plus other stuff
|
||||
(c-set-offset 'case-label '+) ; tweak case indent to match PG custom
|
||||
(setq indent-tabs-mode t)) ; make sure we keep tabs when indenting
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
;;; Similar approach, known to work with xemacs
|
||||
;;; Use of a named style makes it easy to use the style elsewhere
|
||||
|
||||
(c-add-style "pgsql"
|
||||
'("bsd"
|
||||
(indent-tabs-mode . t)
|
||||
(c-basic-offset . 4)
|
||||
(tab-width . 4)
|
||||
(c-offsets-alist .
|
||||
((case-label . +)))
|
||||
)
|
||||
nil ) ; t = set this mode, nil = don't
|
||||
|
||||
(defun pgsql-c-mode ()
|
||||
(c-mode)
|
||||
(c-set-style "pgsql")
|
||||
)
|
||||
|
||||
(setq auto-mode-alist
|
||||
(cons '("\\(postgres\\|pgsql\\).*\\.[chyl]\\'" . pgsql-c-mode)
|
||||
auto-mode-alist))
|
||||
(setq auto-mode-alist
|
||||
(cons '("\\(postgres\\|pgsql\\).*\\.cc\\'" . pgsql-c-mode)
|
||||
auto-mode-alist))
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
;;; Slightly different approach - use a hook instead of a mode
|
||||
|
||||
(add-hook 'c-mode-hook
|
||||
(function
|
||||
(lambda nil
|
||||
(if (string-match "pgsql" buffer-file-name)
|
||||
(progn
|
||||
(c-set-style "bsd")
|
||||
(setq c-basic-offset 4)
|
||||
(setq tab-width 4)
|
||||
(c-set-offset 'case-label '+)
|
||||
(setq indent-tabs-mode t)
|
||||
)
|
||||
))))
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
18
src/tools/editors/vim.samples
Normal file
18
src/tools/editors/vim.samples
Normal file
@ -0,0 +1,18 @@
|
||||
|
||||
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
|
||||
"
|
||||
" These settings are appropriate for editing PostgreSQL code with vim
|
||||
"
|
||||
" You would copy this into your .vimrc or equivalent
|
||||
"
|
||||
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
|
||||
|
||||
:if match(getcwd(), "/pgsql") >=0 || match(getcwd(), "/postgresql") >= 0
|
||||
|
||||
: set cinoptions=(0
|
||||
: set tabstop=4
|
||||
: set shiftwidth=4
|
||||
|
||||
:endif
|
||||
|
||||
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
|
Loading…
Reference in New Issue
Block a user