cvs: peardoc /en/chapters standards.xml
[email protected] ("Christian Weiske")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvscweiske1241467337@cvsserver> |
cweiske Mon May 4 20:02:17 2009 UTC
Modified files:
/peardoc/en/chapters standards.xml
Log:
Link to CS rfcs
http://cvs.php.net/viewvc.cgi/peardoc/en/chapters/standards.xml?r1=1.68&r2=1.69&diff_format=u
Index: peardoc/en/chapters/standards.xml
diff -u peardoc/en/chapters/standards.xml:1.68 peardoc/en/chapters/standards.xml:1.69
--- peardoc/en/chapters/standards.xml:1.68 Thu Oct 9 15:16:09 2008
+++ peardoc/en/chapters/standards.xml Mon May 4 20:02:17 2009
@@ -1,5 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
-<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="standards"><info><title>Coding Standards</title></info>
+<chapter xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="standards">
+ <info>
+ <title>Coding Standards</title>
+ </info>
<note>
<simpara>
@@ -9,7 +12,34 @@
and maintainable by most of PEAR folks.
</simpara>
</note>
- <section xml:id="standards.indenting"><info><title>Indenting and Line Length</title></info>
+
+ <para>
+ The original coding standards have been adjusted several times through
+ RFCs:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="rfc.cs-enhancements">Coding standard enhancements</link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="rfc.protected-members">Protected members</link>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Those RFCs have not yet been integrated into this document.
+ </para>
+
+
+ <section xml:id="standards.indenting">
+ <info>
+ <title>Indenting and Line Length</title>
+ </info>
<para>
Use an indent of 4 spaces, with no tabs. This helps to avoid problems
@@ -19,8 +49,7 @@
For Emacs you should set indent-tabs-mode to nil. Here is an example
mode hook that will set up Emacs (ensure that it is called when you
are editing PHP files):
- <programlisting role="elisp">
- <![CDATA[
+ <programlisting role="elisp"><![CDATA[
(defun php-mode-hook ()
(setq tab-width 4
c-basic-offset 4
@@ -29,18 +58,15 @@
(not
(and (string-match "/\\(PEAR\\|pear\\)/" (buffer-file-name))
(string-match "\.php$" (buffer-file-name))))))
- ]]>
- </programlisting>
+ ]]></programlisting>
</para>
<para>Here are Vim rules for the same thing:
- <programlisting role="vim">
- <![CDATA[
+ <programlisting role="vim"><![CDATA[
set expandtab
set shiftwidth=4
set softtabstop=4
set tabstop=4
- ]]>
- </programlisting>
+ ]]></programlisting>
</para>
<para>
It is recommended to keep lines at approximately 75-85 characters long