diff options
Diffstat (limited to 'phpBB/docs/coding-guidelines.html')
-rw-r--r-- | phpBB/docs/coding-guidelines.html | 137 |
1 files changed, 24 insertions, 113 deletions
diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index 1978a0a307..cd3c09f6fb 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -8,7 +8,7 @@ <meta http-equiv="imagetoolbar" content="no" /> <meta name="resource-type" content="document" /> <meta name="distribution" content="global" /> -<meta name="copyright" content="2007 phpBB Group" /> +<meta name="copyright" content="phpBB Group" /> <meta name="keywords" content="" /> <meta name="description" content="Olympus coding guidelines document" /> <title>phpBB3 • Coding Guidelines</title> @@ -90,10 +90,9 @@ <li><a href="#vcs">VCS Guidelines</a> <ol style="list-style-type: lower-roman;"> <li><a href="#repostruct">Repository structure</a></li> - <li><a href="#commitmessage">Commit messages</a></li> + <li><a href="#commitmessage">Commit Messages and Repository Rules</a></li> </ol> </li> - <li><a href="#changes">Guidelines Changelog</a></li> <li><a href="#disclaimer">Copyright and disclaimer</a></li> </ol> @@ -241,6 +240,11 @@ PHPBB_ACM_MEMCACHE_PORT (overwrite memcached port, default is 11211) PHPBB_ACM_MEMCACHE_COMPRESS (overwrite memcached compress setting, default is disabled) PHPBB_ACM_MEMCACHE_HOST (overwrite memcached host name, default is localhost) +PHPBB_ACM_REDIS_HOST (overwrite redis host name, default is localhost) +PHPBB_ACM_REDIS_PORT (overwrite redis port, default is 6379) +PHPBB_ACM_REDIS_PASSWORD (overwrite redis password, default is empty) +PHPBB_ACM_REDIS_DB (overwrite redis default database) + PHPBB_QA (Set board to QA-Mode, which means the updater also checks for RC-releases) </pre></div> @@ -1019,7 +1023,7 @@ append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=group&amp; <h4>General function usage: </h4> - <p>Some of these functions are only chosen over others because of personal preference and having no other benefit than to be consistant over the code.</p> + <p>Some of these functions are only chosen over others because of personal preference and having no other benefit than to be consistent over the code.</p> <ul> <li> @@ -2326,126 +2330,33 @@ if (utf8_case_fold_nfc($string1) == utf8_case_fold_nfc($string2)) <div class="content"> - <p>The version control system for phpBB3 is subversion. The repository is available at <a href="http://code.phpbb.com/svn/phpbb" title="repository">http://code.phpbb.com/svn/phpbb</a>.</p> + <p>The version control system for phpBB3 is git. The repository is available at <a href="http://github.com/phpbb/phpbb3" title="repository">http://github.com/phpbb/phpbb3</a>.</p> <a name="repostruct"></a><h3>7.i. Repository Structure</h3> <ul> - <li><strong>trunk</strong><br />The latest unstable development version with new features etc. Contains the actual board in <code>/trunk/phpBB</code></li> - <li><strong>branches</strong><br />Development branches of stable phpBB releases. Copied from <code>/trunk</code> at the time of release. + <li><strong>develop</strong><br />The latest unstable development version with new features etc.</li> + <li><strong>develop-*</strong><br />Development branches of stable phpBB releases. Branched off of <code>develop</code> at the time of feature freeze. <ul> - <li><strong>phpBB3.0</strong><code>/branches/phpBB-3_0_0/phpBB</code><br />Development branch of the stable 3.0 line. Bug fixes are applied here.</li> - <li><strong>phpBB2</strong><code>/branches/phpBB-2_0_0/phpBB</code><br />Old phpBB2 development branch.</li> + <li><strong>phpBB3.0</strong><code>develop-olympus</code><br />Development branch of the stable 3.0 line. Bug fixes are applied here.</li> + <li><strong>phpBB3.1</strong><code>develop-ascraeus</code><br />Development branch of the stable 3.1 line. Bug fixes are applied here.</li> </ul> </li> - <li><strong>tags</strong><br />Released versions. Copies of trunk or the respective branch, made at the time of release. + <li><strong>master</strong><br />A branch containing all stable phpBB3 release points</li> + <li><strong>tags</strong><br />Released versions. Stable ones get merged into the master branch. <ul> - <li><code>/tags/release_3_0_BX</code><br />Beta release X of the 3.0 line.</li> - <li><code>/tags/release_3_0_RCX</code><br />Release candidate X of the 3.0 line.</li> - <li><code>/tags/release_3_0_X-RCY</code><br />Release candidate Y of the stable 3.0.X release.</li> - <li><code>/tags/release_3_0_X</code><br />Stable <strong>3.0.X</strong> release.</li> - <li><code>/tags/release_2_0_X</code><br />Old stable 2.0.X release.</li> + <li><code>release-3.Y-BX</code><br />Beta release X of the 3.Y line.</li> + <li><code>release-3.Y-RCX</code><br />Release candidate X of the 3.Y line.</li> + <li><code>release-3.Y.Z-RCX</code><br />Release candidate X of the stable 3.Y.Z release.</li> + <li><code>release-3.0.X</code><br />Stable <strong>3.0.X</strong> release.</li> + <li><code>release-2.0.X</code><br />Old stable 2.0.X release.</li> </ul> </li> </ul> - <a name="commitmessage"></a><h3>7.ii. Commit Messages</h3> - - <p>The commit message should contain a brief explanation of all changes made within the commit. Often identical to the changelog entry. A bug ticket can be referenced by specifying the ticket ID with a hash, e.g. #12345. A reference to another revision should simply be prefixed with r, e.g. r12345.</p> - - <p>Junior Developers need to have their patches approved by a development team member first. The commit message must end in a line with the following format:</p> - - <div class="codebox"><pre> -Authorised by: developer1[, developer2[, ...]] - </pre></div> - - </div> - - <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div> - - <span class="corners-bottom"><span></span></span></div> - </div> - - <hr /> - -<a name="changes"></a><h2>8. Guidelines Changelog</h2> - <div class="paragraph"> - <div class="inner"><span class="corners-top"><span></span></span> - - <div class="content"> -<h3>Revision 10007</h3> - -<ul> - <li>Added <a href="#constants">Special Constants</a> section.</li> -</ul> - -<h3>Revision 9817</h3> - -<ul> - <li>Added VCS section.</li> -</ul> - -<h3>Revision 8732</h3> - -<ul> - <li>Added cfg files.</li> - <li>Added template <a href="#inheritance">inheritance</a>.</li> -</ul> - -<h3>Revision 8596+</h3> - -<ul> - <li>Removed sql_build_array('MULTI_INSERT'... statements.</li> - <li>Added sql_multi_insert() explanation.</li> -</ul> - -<h3>Revision 1.31</h3> - -<ul> - <li>Added add_form_key and check_form_key. </li> -</ul> - -<h3>Revision 1.24</h3> - -<ul> - <li>Added <a href="#translation">5. Character Sets and Encodings</a> section to explain the recommended treatment of strings in phpBB.</li> -</ul> - -<h3>Revision 1.16</h3> - -<ul> - <li>Added <a href="#translation">6. Translation (<abbr title="Internationalisation">i18n</abbr>/<abbr title="Localisation">L10n</abbr>) Guidelines</a> section to explain expected format and authoring considerations for language packs that are to be created for phpBB.</li> -</ul> - -<h3>Revision 1.11-1.15</h3> - -<ul> - <li>Various document formatting, spelling, punctuation, grammar bugs.</li> -</ul> - -<h3>Revision 1.9-1.10</h3> - -<ul> - <li>Added sql_query_limit to <a href="#sql">2.iii. SQL/SQL Layout</a>.</li> -</ul> - -<h3>Revision 1.8</h3> - -<ul> - <li>Some adjustements to wordings</li> - <li>Updated paragraph <a href="#locations">1.iii. File Locations</a> to reflect recent changes</li> - <li>Extended paragraph <a href="#codelayout">2.ii. Code Layout</a>.</li> - <li>Added sql_in_set and sql_build_query explanation to <a href="#sql">2.iii. SQL/SQL Layout</a>.</li> - <li>Updated paragraph <a href="#styling">3. Styling</a>.</li> - <li>Updated paragraph <a href="#templating">4. Templating</a> to explain loop checking, loop breaking and other changes we recently made.</li> -</ul> - -<h3>Revision 1.5</h3> - -<ul> - <li>Changed General function usage paragraph in <a href="#general">2.v. General Guidelines</a></li> -</ul> + <a name="commitmessage"></a><h3>7.ii. Commit Messages and Repository Rules</h3> + <p>Information on repository rules, such as commit messages can be found at <a href="http://wiki.phpbb.com/display/DEV/Git" title="phpBB Git Information">http://wiki.phpbb.com/display/DEV/Git</a>.</p> </div> @@ -2463,7 +2374,7 @@ Authorised by: developer1[, developer2[, ...]] <div class="content"> - <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-license.php">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2000, 2002, 2005, 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-license.php">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> </div> @@ -2475,7 +2386,7 @@ Authorised by: developer1[, developer2[, ...]] <!-- END DOCUMENT --> <div id="page-footer"> - <div class="version"> $Id$ </div> + <div class="version"> </div> </div> </div></div> |