database/postgres
database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-05-06 19:59:18 +03:00
Code

Add a note about preferred window width to the section about code

Browse Source 
formatting conventions.
This commit is contained in:
Tom Lane 2010-07-10 18:37:00 +00:00
parent 2e6d24a621
commit 4720ad515e
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/src/sgml/sources.sgml
View File

@ -1,4 +1,4 @@
<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.36 2010/06/28 17:48:26 petere Exp $ --> <!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.37 2010/07/10 18:37:00 tgl Exp $ -->
<chapter id="source"> <chapter id="source">
<title>PostgreSQL Coding Conventions</title> <title>PostgreSQL Coding Conventions</title>
@ -18,6 +18,13 @@
<literal>while</>, <literal>switch</>, etc go on their own lines. <literal>while</>, <literal>switch</>, etc go on their own lines.
</para> </para>
<para>
Limit line lengths so that the code is readable in an 80-column window.
(This doesn't mean that you must never go past 80 columns. For instance,
breaking a long error message string in arbitrary places just to keep the
code within 80 columns is probably not a net gain in readability.)
</para>
<para> <para>
Do not use C++ style comments (<literal>//</> comments). Strict ANSI C Do not use C++ style comments (<literal>//</> comments). Strict ANSI C
compilers do not accept them. For the same reason, do not use C++ compilers do not accept them. For the same reason, do not use C++
@ -50,6 +57,8 @@
rules, it's a good idea to do so. Your code will get run through rules, it's a good idea to do so. Your code will get run through
<application>pgindent</> before the next release, so there's no point in <application>pgindent</> before the next release, so there's no point in
making it look nice under some other set of formatting conventions. making it look nice under some other set of formatting conventions.
A good rule of thumb for patches is <quote>make the new code look like
the existing code around it</>.
</para> </para>
<para> <para>