You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2013/08/08 15:37:16 UTC
svn commit: r873496 - in /websites/staging/directory/trunk/content: ./
mavibot/coding-standards.html mavibot/developer-guide.html
Author: buildbot
Date: Thu Aug 8 13:37:15 2013
New Revision: 873496
Log:
Staging update by buildbot for directory
Added:
websites/staging/directory/trunk/content/mavibot/coding-standards.html
websites/staging/directory/trunk/content/mavibot/developer-guide.html
Modified:
websites/staging/directory/trunk/content/ (props changed)
Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Aug 8 13:37:15 2013
@@ -1 +1 @@
-1511171
+1511775
Added: websites/staging/directory/trunk/content/mavibot/coding-standards.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/coding-standards.html (added)
+++ websites/staging/directory/trunk/content/mavibot/coding-standards.html Thu Aug 8 13:37:15 2013
@@ -0,0 +1,254 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+ <head>
+ <title>Mavibot Coding Standards — Apache Directory</title>
+
+ <link href="./../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../css/turquoise.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../images/mavibot-icon_16x16.png">
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ _uacct = "UA-1358462-1";
+ urchinTracker();
+ </script>
+ </head>
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="subProjectsNavBar">
+ <a href="./../">
+
+ Apache Directory Project
+
+ </a>
+ |
+ <a href="./../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../studio">
+
+ Apache Directory Studio
+
+ </a>
+ |
+ <a href="./../api">
+
+ Apache LDAP API
+
+ </a>
+ |
+ <a href="./../mavibot">
+
+ <STRONG>Mavibot</STRONG>
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../mavibot/downloads.html">Version 1.0.0-M1</a> <IMG src="./../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../mavibot/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../mavibot/vision.html">Vision</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../mavibot/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../mavibot/user-guide.html">User Guide</a></li>
+ <li><a href="./../mavibot/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <!--li><a href="./../mavibot/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../mavibot/developer-guide.html">Developer Guide</a></li>
+ </ul>
+
+
+ <h5>Support</h5>
+ <ul>
+ <li><a href="./../mailing-lists-and-irc.html">Mailing Lists & IRC</a></li>
+ <li><a href="./../sources.html">Sources</a></li>
+ <li><a href="./../issue-tracking.html">Issue Tracking</a></li>
+ <li><a href="./../commercial-support.html">Commercial Support</a></li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li><a href="./../contribute.html">How to Contribute</a></li>
+ <li><a href="./../team.html">Team</a></li>
+ <li><a href="./../original-project-proposal.html">Original Project Proposal</a></li>
+ <li><a href="./../special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
+ </ul>
+ <h5>About Apache</h5>
+ <ul>
+ <li><a href="http://www.apache.org/">Apache</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../images/banner-ldapcon-2013.png" alt="LDAPCon 2013" width="167" height="231"></a>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+
+<h1 id="mavibot-coding-standards">Mavibot Coding Standards</h1>
+<p>Welcome to you, developper ! You have been elected committer on the project, or you want to contribute some code or some patch? This is great news. However, in order to be able to share your 'vision' and your code, some rules must be followed.</p>
+<p>Hey, remember that those rules are not the best nor the worst, they are pretty much what they are for historical reasons, or for technical reasons, however, please, accept them as they are, and avoid religious war (please, oh please, no mail to say "WTF ? You are using spaces instead of tab ??? How stupid is this rule etc etc.) Rules are <em><em>alway</em>s</em> stupid, but smart people follow them ;)</p>
+<p><strong>eclipse IDE</strong></p>
+<p>Eclipse users can import those two files to enfore the code formating : <a href="http://svn.apache.org/repos/asf/directory/project/trunk/resources/formatting.xml">formatting.xml</a> and <a href="http://svn.apache.org/repos/asf/directory/project/trunk/resources/codetemplates.xml">codetemplates.xml</a></p>
+<p><strong>IDEA IDE</strong></p>
+<p>IDEA users can import <a href="settings.jar">this file</a> to enfore the code formating.</p>
+<h2 id="headers">Headers</h2>
+<p>First, you <strong>must</strong> (and this rule accept no exception) use this header in top of all source file, or each file in which you can have comments :</p>
+<div class="codehilite"><pre><span class="cm">/*</span>
+<span class="cm"> * Licensed to the Apache Software Foundation (ASF) under one</span>
+<span class="cm"> * or more contributor license agreements. See the NOTICE file</span>
+<span class="cm"> * distributed with this work for additional information</span>
+<span class="cm"> * regarding copyright ownership. The ASF licenses this file</span>
+<span class="cm"> * to you under the Apache License, Version 2.0 (the</span>
+<span class="cm"> * "License"); you may not use this file except in compliance</span>
+<span class="cm"> * with the License. You may obtain a copy of the License at</span>
+<span class="cm"> *</span>
+<span class="cm"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="cm"> *</span>
+<span class="cm"> * Unless required by applicable law or agreed to in writing,</span>
+<span class="cm"> * software distributed under the License is distributed on an</span>
+<span class="cm"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
+<span class="cm"> * KIND, either express or implied. See the License for the</span>
+<span class="cm"> * specific language governing permissions and limitations</span>
+<span class="cm"> * under the License.</span>
+<span class="cm"> *</span>
+<span class="cm"> */</span>
+</pre></div>
+
+
+<h3 id="classinterface-headers">Class/Interface headers</h3>
+<p>Each <strong>Class</strong> or <em>Interface</em> should have an header which must contains :</p>
+<ul>
+<li>A descrption of this class/interface</li>
+<li>
+<p>an <em>author</em> tag which should be :</p>
+<div class="codehilite"><pre><span class="nd">@author</span> <span class="o"><</span><span class="n">a</span> <span class="n">href</span><span class="o">=</span><span class="s">"mailto:dev@directory.apache.org"</span><span class="o">></span><span class="n">Apache</span> <span class="n">Directory</span> <span class="n">Project</span><span class="o"></</span><span class="n">a</span><span class="o">></span>
+</pre></div>
+
+
+</li>
+</ul>
+<DIV class="note" markdown="1">
+Thanks to avoid to put your name. The code is not yours, and much more important, but putting ypur name and e-mail, you will intimidate other developper ("Oh, no, I won't mess with this code, it has been developped by XXXX \!") and second, you will receive mail in three years even if you have stopped all commitment on the project (and those who have sent you an e-mail will think that the project's memeber are not responsive...)
+</DIV>
+
+<p>If you use <strong>html</strong> tags, remember to escape '<' and '>' characters...</p>
+<h3 id="static-members-and-other-members">Static members and other members</h3>
+<p>Just add a single line javadoc comment like : <em>/*<em> blah ... </em>/</em> before each member</p>
+<h3 id="methods">Methods</h3>
+<p>Follow the standard <strong>javadoc</strong> rules : Description, <strong>@param</strong>, <strong>@exception</strong> and <strong>@return</strong>. It should be enough. Avoid <strong>@tags</strong>, <strong>@todo</strong> tags, etc...</p>
+<p>Escape <strong>html</strong> characters</p>
+<h2 id="comments">Comments</h2>
+<p>No special rules, except that you should avoid :</p>
+<ul>
+<li>Useless comments like : i++; /* Increment i */</li>
+<li>Overusing comments : if you have to heavily comment a peice of code, then this piece of code might be too complex ...</li>
+<li>Speading little comments all over a method : if possible, write blocs of comments. The method header could hgenerally contains a full description of the code, and if it's not the case, just consider your method might be too long !</li>
+<li>Dead code commented. If it's dead, then put it in a cuffin. We use SVN, the Ressuscitator !</li>
+</ul>
+<p>Basically, use your common sense :-)</p>
+<h2 id="naming">Naming</h2>
+<p>Naming ! Sounds like Blaming :-). Ok. We use <strong>Sun(tm/c/r)</strong> style :</p>
+<ul>
+<li>Constants are in UPPER CASE with accepted '_'</li>
+<li>Class starts with an uppercase and each starting word is upper cased. No '_', please !</li>
+<li>Methods starts with lower case and then follow the same rule than classes. No '_', please !</li>
+<li>Interfaces should not start with an 'I'</li>
+<li>Classes which implements an Interface must be followed by the postfix 'impl'</li>
+<li>Variables follow the method naming convention. No '_', please !</li>
+<li>Use meaningfull names.</li>
+<li>No double letter variables like ii, jj etc...</li>
+</ul>
+<p>If you browse the code, you will see that many classes does not respect those rules. That's life ! Don't fix it if you don't touch a class. If you are fixing a method in a class, then you can change the code to respect the rules. Little by little, we may reach a stable state where all the code respect the rules ;)</p>
+<p>Naming is really important for <strong>APIs</strong>. Be smart. If you are not sure, ask.</p>
+<h2 id="spaces-vs-tabs">Spaces vs tabs</h2>
+<DIV class="warning" markdown="1">
+**FOUR SPACES, NO TAB. Final.**
+</DIV>
+
+<p>No discussion. Using tabs break diffs. Modify your <strong>IDE</strong> to insert spaces when you use tabs, before it saves the file.</p>
+<h2 id="formatting">Formatting</h2>
+<p>Use the <strong>formatting.xml</strong> file which can be found in the <strong>resources</strong> directory in the root of the project. This is for <em>Eclipse</em>. If you don't use eclipse, then translate the formating to your favorite <strong>IDE</strong>.</p>
+<p>Use the <strong>codetemplates.xml</strong> file if you are using <em>Eclipse</em> too. You will find it at the same location. It brings you some standard headers for new classes, nex methods, etc.</p>
+<p>Use <strong>UTF-8</strong> as a default for your files (except for properties, thanks to <strong>java</strong>, which should be in <strong>ISO-8859-1</strong>). Forget about exotic encoding...</p>
+<DIV class="warning" markdown="1">
+**DO NOT USE AN AUTOMATIC FORMATER FOR COMMENTS!!!**
+</DIV>
+
+<p>People spend a lot of time making their comment looks like pretty, so if you just format them, you will have to recover the previous comments...</p>
+<p>Some general rules :</p>
+<ul>
+<li>Always use '{' and '}' even for a single instruction, or if you have an empty block (don't use ';' for empty blocks)</li>
+<li>No more than one instruction on a single line, the only exception is the '?' ':' operation</li>
+<li>Use <em>this</em> to address the class variable if there is a risk of confusion (for instanc eif you have a parameter with the same name.</li>
+<li>Don't add a 'a_', or 'the_' before a parameter's name to distinguish it from the class variable which has the same name. Use <strong>this</strong> instead.</li>
+<li>Don't add <strong>final</strong> everywhere. Even if <strong>final</strong> is a substitute for <strong>const</strong>, it's semantic is not clear enough that you use it everywhere.</li>
+<li>Add spaces in method calls after '(' and before ')'</li>
+<li>'{' and '}' must be on the same column</li>
+</ul>
+<p>This is a code example :</p>
+<div class="codehilite"><pre><span class="o">...</span>
+<span class="kt">int</span> <span class="n">result</span> <span class="o">=</span> <span class="n">myMethod</span><span class="o">(</span> <span class="n">param1</span><span class="o">,</span> <span class="n">param2</span> <span class="o">)</span>
+
+<span class="k">if</span> <span class="o">(</span> <span class="n">result</span> <span class="o">></span> <span class="mi">0</span> <span class="o">)</span>
+<span class="o">{</span>
+ <span class="c1">// do something</span>
+<span class="o">}</span>
+<span class="o">...</span>
+</pre></div>
+
+
+<h2 id="imports">Imports</h2>
+<p>Always declare all the classes you import, do not use <strong>x.y.*</strong></p>
+<h2 id="what-else">What else ?</h2>
+<p>Well, this was a very short introduction about coding rules. Use commen sense, look at what you see around you when adding some code, ask people about format, if you have a question.</p>
+<p>That's it ! (I wait your comments, guys :-)</p>
+
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2012, <a href="http://www.apache.org">The Apache Software Foundation</a> - <a href="./../privacy-policy.html">Privacy Policy</a><br />
+ Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
Added: websites/staging/directory/trunk/content/mavibot/developer-guide.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/developer-guide.html (added)
+++ websites/staging/directory/trunk/content/mavibot/developer-guide.html Thu Aug 8 13:37:15 2013
@@ -0,0 +1,442 @@
+<!DOCTYPE html>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+ <head>
+ <title>Mavibot Developers Guide — Apache Directory</title>
+
+ <link href="./../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../css/turquoise.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../images/mavibot-icon_16x16.png">
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ _uacct = "UA-1358462-1";
+ urchinTracker();
+ </script>
+ </head>
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="subProjectsNavBar">
+ <a href="./../">
+
+ Apache Directory Project
+
+ </a>
+ |
+ <a href="./../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../studio">
+
+ Apache Directory Studio
+
+ </a>
+ |
+ <a href="./../api">
+
+ Apache LDAP API
+
+ </a>
+ |
+ <a href="./../mavibot">
+
+ <STRONG>Mavibot</STRONG>
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../mavibot/downloads.html">Version 1.0.0-M1</a> <IMG src="./../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../mavibot/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../mavibot/vision.html">Vision</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../mavibot/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../mavibot/user-guide.html">User Guide</a></li>
+ <li><a href="./../mavibot/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <!--li><a href="./../mavibot/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../mavibot/developer-guide.html">Developer Guide</a></li>
+ </ul>
+
+
+ <h5>Support</h5>
+ <ul>
+ <li><a href="./../mailing-lists-and-irc.html">Mailing Lists & IRC</a></li>
+ <li><a href="./../sources.html">Sources</a></li>
+ <li><a href="./../issue-tracking.html">Issue Tracking</a></li>
+ <li><a href="./../commercial-support.html">Commercial Support</a></li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li><a href="./../contribute.html">How to Contribute</a></li>
+ <li><a href="./../team.html">Team</a></li>
+ <li><a href="./../original-project-proposal.html">Original Project Proposal</a></li>
+ <li><a href="./../special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
+ </ul>
+ <h5>About Apache</h5>
+ <ul>
+ <li><a href="http://www.apache.org/">Apache</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../images/banner-ldapcon-2013.png" alt="LDAPCon 2013" width="167" height="231"></a>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+
+<h1 id="mavibot-developers-guide">Mavibot Developers Guide</h1>
+<h2 id="getting-the-source-building-the-trunks">Getting the source, Building the trunks</h2>
+<h3 id="prerequisites-for-building">Prerequisites for building</h3>
+<p>You must have installed <strong>Maven 3.0.4</strong> and have a <strong>JDK 7</strong> installed on your computer. A working internet connection is also mandatory, unless you have all the needed dependences and plugins loaded locally.</p>
+<DIV class="note" markdown="1">
+If the build hangs or you get an out of memory exception please increase the heap space:
+
+* For Linux:
+
+ MAVEN_OPTS="-Xmx1024m" mvn clean install
+
+* For Windows:
+
+ SET MAVEN_OPTS="-Xmx1024m"
+ mvn clean install
+</DIV>
+
+<h3 id="maven">Maven</h3>
+<p><a href="http://maven.apache.org/download.html">Download</a> and install Maven 3.0.4.</p>
+<p>Add a MAVEN_HOME environment variable and add MAVEN_HOME/bin to your system path:</p>
+<p>On a Linux box you could add the following to the .bashrc file (.bashrc is a file you'll find in your home directory)</p>
+<div class="codehilite"><pre><span class="p">...</span>
+<span class="n">export</span> <span class="n">MAVEN_HOME</span><span class="p">=</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">maven</span><span class="o">-</span>3<span class="p">.</span>0<span class="p">.</span>4
+<span class="n">export</span> <span class="n">PATH</span><span class="p">=</span>$<span class="n">JAVA_HOME</span><span class="p">:</span>$<span class="n">JAVA_HOME</span><span class="o">/</span><span class="n">bin</span><span class="p">:</span>$<span class="n">MAVEN_HOME</span><span class="o">/</span><span class="n">bin</span><span class="p">:</span>$<span class="n">PATH</span>
+<span class="p">...</span>
+</pre></div>
+
+
+<p>Windows users, use Control Panel -> System -> Advanced -> Environment Variables</p>
+<h3 id="jdk-7">JDK 7</h3>
+<DIV class="note" markdown="1">
+We recommend using a version >= 1.7
+</DIV>
+
+<p>Any newer version should also work.</p>
+<h2 id="getting-the-code">Getting the code</h2>
+<p>To download the sources from trunk, you must have installed a <strong>Subversion</strong> client.</p>
+<p>With readonly access :</p>
+<div class="codehilite"><pre><span class="n">svn</span> <span class="n">co</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">svn</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">asf</span><span class="o">/</span><span class="n">directory</span><span class="o">/</span><span class="n">mavibot</span><span class="o">/</span><span class="n">trunk</span> <span class="n">mavibot</span><span class="o">-</span><span class="n">trunk</span>
+</pre></div>
+
+
+<p>With read/write access (for committers only) :</p>
+<div class="codehilite"><pre><span class="n">svn</span> <span class="n">co</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">svn</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">asf</span><span class="o">/</span><span class="n">directory</span><span class="o">/</span><span class="n">mavibot</span><span class="o">/</span><span class="n">trunk</span> <span class="n">mavibot</span><span class="o">-</span><span class="n">trunk</span>
+</pre></div>
+
+
+<h2 id="building-the-trunk">Building the trunk</h2>
+<p>You may either specify the profile at the command-line, each time you use 'mvn', or you may configure the profile to always be active.</p>
+<p>To use a profile at the command-line:</p>
+<div class="codehilite"><pre><span class="c"># mvn [-P<profile>] [options] [<goal(s)>] [<phase(s)>]</span>
+</pre></div>
+
+
+<h3 id="building-the-trunk-for-real">Building the trunk, for real</h3>
+<p>Now, we can compile the projects.</p>
+<p>The command is simple :</p>
+<div class="codehilite"><pre><span class="n">cd</span> <span class="n">mavibot</span><span class="o">-</span><span class="n">trunk</span>
+<span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span>
+</pre></div>
+
+
+<p>A lot of plugins will be downloaded. If you are curious, you can then look at .m2/repository to see what has been downloaded on this step.</p>
+<p>Building should finish with these lines:</p>
+<div class="codehilite"><pre>[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESSFUL
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 8 minutes 30 seconds
+[INFO] Finished at: Mon Oct 30 23:32:41 CET 2006
+[INFO] Final Memory: 18M/32M
+[INFO] ------------------------------------------------------------------------
+</pre></div>
+
+
+<p>That's it, the jars will be find in target/mavibot-1.0.0-M?-<XXXXXX>-setup.jar where XXXXXX is your local system and M? is the milestone release number for the 1.0 branch.</p>
+<h2 id="eclipse">Eclipse</h2>
+<p>We use Eclipse extensively, so these chapters, byt any other idea would be ok too.</p>
+<h3 id="building-eclipse-files">Building eclipse files</h3>
+<p>To build the .project and .classpath files for eclipse, type the following commands :</p>
+<div class="codehilite"><pre><span class="n">cd</span> <span class="n">mavibot</span><span class="o">-</span><span class="n">trunk</span>
+<span class="n">mvn</span> <span class="n">eclipse</span><span class="p">:</span><span class="n">eclipse</span>
+</pre></div>
+
+
+<h3 id="maven-settings">Maven settings</h3>
+<p>Don't forget to declare a classpath variable named M2_REPO, pointing to ~/.m2/repository, otherwise many links to existing jars will be broken.</p>
+<p>You can declare new variables in Eclipse in <em>Windows -> Preferences...</em> and selecting <em>Java -> Build Path -> Classpath Variables</em></p>
+<h2 id="coding-standards">Coding standards</h2>
+<p>The applicable coding standards for Mavibot are described in <a href="coding-standards.html">Coding Standards</a></p>
+<p>There are some more rules, as we are using <strong>Java 7</strong> now :</p>
+<ul>
+<li>Use generics as much as you can. Generic are a good way to avoid casting, and it enforce the usage of the correct type.</li>
+<li>If you can avoid <em>Iterators</em>, do so. There is this cool construction with a <strong>for( Type t:<collection instance> )</strong> : use it !</li>
+<li>Use <strong>assert</strong>. It's usefull, especially instead of a bunch of <strong>if (<test is wrong>)</strong> then throw Exception* when controlling incoming parameters</li>
+<li>Use the new <em>Enum</em> type !</li>
+</ul>
+<h1 id="releasing-mavibot">Releasing Mavibot</h1>
+<p>Since we are using Nexus for releases the release process is as follows (see also <a href="publishing-maven-artifacts.html">http://www.apache.org/dev/publishing-maven-artifacts.html#staging-maven</a>).</p>
+<h2 id="test-the-project">Test the Project</h2>
+<div class="codehilite"><pre>$ mvn release:prepare -DdryRun=true
+</pre></div>
+
+
+<p>Be aware that this phase will ask you about the next version, and most important, for the next SCM tag :</p>
+<div class="codehilite"><pre>...
+[INFO] Checking dependencies and plugins for snapshots ...
+What is the release version for "ApacheDS Mavibot Parent"? (org.apache.directory.mavibot:mavibot-parent) 1.0.0-M1: :
+What is the release version for "ApacheDS MVCC BTree implementation"? (org.apache.directory.mavibot:mavibot) 1.0.0-M1: :
+What is the release version for "Apache Mavibot Distribution"? (org.apache.directory.mavibot:distribution) 1.0.0-M1: :
+What is SCM release tag or label for "ApacheDS Mavibot Parent"? (org.apache.directory.mavibot:mavibot-parent) 1.0.0-M1: :
+What is the new development version for "ApacheDS Mavibot Parent"? (org.apache.directory.mavibot:mavibot-parent) 1.0.0-M2-SNAPSHOT: :
+What is the new development version for "ApacheDS MVCC BTree implementation"? (org.apache.directory.mavibot:mavibot) 1.0.0-M2-SNAPSHOT: :
+What is the new development version for "Apache Mavibot Distribution"? (org.apache.directory.mavibot:distribution) 1.0.0-M2-SNAPSHOT: :
+</pre></div>
+
+
+<p>Here, we just validated the proposed versions.</p>
+<h2 id="deploy-a-snapshot">Deploy a Snapshot</h2>
+<div class="codehilite"><pre>$ mvn deploy
+</pre></div>
+
+
+<p>This is useful to verify your settings in ~/.m2/settings.xml (Nexus password and GPG key)</p>
+<h2 id="prepare-the-release">Prepare the Release</h2>
+<div class="codehilite"><pre>$ mvn release:clean
+$ mvn release:prepare
+</pre></div>
+
+
+<p>This creates a tag here: http://svn.apache.org/viewvc/directory/mavibot/tags/</p>
+<h2 id="stage-the-release">Stage the Release</h2>
+<div class="codehilite"><pre>$ mvn release:perform
+</pre></div>
+
+
+<p>This deploys the release to a staging repository.</p>
+<p>Go to https://repository.apache.org/index.html#stagingRepositories and close the staging repository.</p>
+<h2 id="build-the-site">Build the Site</h2>
+<div class="codehilite"><pre>$ cd target/checkout
+$ mvn site
+</pre></div>
+
+
+<p>This creates the site.</p>
+<p>Now, you have to sign the binary packages which are in target/checkout/distribution/target.</p>
+<p>Use your PGP key ID (the pub key, 4096R/[XXXXXXX] where [XXXXXXX] is the key ID)</p>
+<p>You can get the keys by typing :</p>
+<div class="codehilite"><pre><span class="n">gpg</span> <span class="o">--</span><span class="n">list</span><span class="o">-</span><span class="n">keys</span>
+</pre></div>
+
+
+<h2 id="publish-source-and-binary-distribution-packages">Publish Source and Binary Distribution Packages</h2>
+<p>First of all, create a new directory on people.apache.org/public_html to store the pacckages :</p>
+<div class="codehilite"><pre>$ ssh people.apache.org
+$ mkdir public_html/mavibot-<version>
+$ exit
+</pre></div>
+
+
+<p>Then copy the packages :</p>
+<div class="codehilite"><pre>$ cd distributions/target
+$ scp mavibot-<version>-* people.apache.org:public_html/mavibot-<version>/
+</pre></div>
+
+
+<p>Update your index.html file on people.apache.org/public_html to make the packages visible. Here is an example of possible content :</p>
+<div class="codehilite"><pre><span class="nt"><h2></span>Mavibot 1.0.0-M1 tarballs<span class="nt"></h2></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.tar.gz"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.tar.gz<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.tar.gz.asc"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.tar.gz.asc<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.tar.gz.md5"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.tar.gz.md5<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.tar.gz.sha1"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.tar.gz.sha1<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.zip"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.zip<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.zip.asc"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.zip.asc<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.zip.md5"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.zip.md5<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-bin.zip.sha1"</span><span class="nt">></span>mavibot-1.0.0-M1-bin.zip.sha1<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.bz2"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.bz2<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.bz2.asc"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.bz2.asc<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.bz2.md5"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.bz2.md5<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.bz2.sha1"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.bz2.sha1<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.gz"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.gz<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.gz.asc"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.gz.asc<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.gz.md5"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.gz.md5<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.tar.gz.sha1"</span><span class="nt">></span>mavibot-1.0.0-M1-src.tar.gz.sha1<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.zip"</span><span class="nt">></span>mavibot-1.0.0-M1-src.zip<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.zip.asc"</span><span class="nt">></span>mavibot-1.0.0-M1-src.zip.asc<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.zip.md5"</span><span class="nt">></span>mavibot-1.0.0-M1-src.zip.md5<span class="nt"></a><br/></span>
+ <span class="nt"><img</span> <span class="na">src=</span><span class="s">"/icons/compressed.gif"</span> <span class="na">alt=</span><span class="s">"[ ]"</span><span class="nt">><a</span> <span class="na">href=</span><span class="s">"mavibot-1.0.0-M1/mavibot-1.0.0-M1-src.zip.sha1"</span><span class="nt">></span>mavibot-1.0.0-M1-src.zip.sha1<span class="nt"></a><br/></span>
+</pre></div>
+
+
+<h2 id="vote">Vote</h2>
+<p>Start a 72h vote at the dev mailing list.</p>
+<p>Here is an exemple of a mote mail :</p>
+<div class="codehilite"><pre>Hi !
+
+This is the first release of Apache Mavibot, the MVCC BTree in Java !
+
+This milestone is the first step toward a complete MVCC implementation,
+it currently does not handle versions at all. Anyway, it's already a in
+memory/On disk full BTree implementation, which is 2 to 3 times faster
+than JDBM.
+
+The next milestones will add the missing features :
+- bulk load support
+- multi-version support with free pages management
+- transaction support
+
+ApacheDS has already been tested with Mavibot 1.0.-M1-SNAPSHOT, and it
+offers pretty good performances compared to JDBM, except when we inject
+a lot of entries in the server.
+
+So let's vote now !
+
+
+The revision :
+
+http://svn.apache.org/r1511750
+
+
+The SVN tag:
+https://svn.apache.org/repos/asf/directory/mavibot/tags/1.0.0-M1/
+
+The source and binary distribution packages:
+http://people.apache.org/~elecharny/
+
+The staging repository:
+https://repository.apache.org/content/repositories/orgapachedirectory-073/
+
+
+Please cast your votes:
+[ ] +1 Release Mavibot 1.0.0-M1
+[ ] 0 abstain
+[ ] -1 Do not release Mavibot 1.0.0-M1
+
+Emmanuel
+</pre></div>
+
+
+<h2 id="release">Release</h2>
+<p>If the vote succeeds the Mavibot project can be released.</p>
+<p>Go to https://repository.apache.org/index.html#stagingRepositories and release the staging repository so all artifacts are published to Maven central.</p>
+<p>Move the distribution packages (sources and binaries) to the dist SVN repository: https://dist.apache.org/repos/dist/release/directory/mavibot/dist/$(version)</p>
+<p>The best solution would be to checkout the directory in people.apache.org, to copy the packages in the right place, and to check in the changes :</p>
+<p>$ ssh people.apache.org</p>
+<h1 id="svn-co-httpsdistapacheorgreposdistreleasedirectorymavibotdist-api-dist">svn co https://dist.apache.org/repos/dist/release/directory/mavibot/dist/ api-dist</h1>
+<h1 id="cd-api-dist">cd api-dist</h1>
+<h1 id="mkdir-wzxhzdk22">mkdir <version></h1>
+<h1 id="cp-public_htmlmavibot-wzxhzdk23-wzxhzdk24">cp ../public_html/mavibot-<version>/* <version></h1>
+<h1 id="svn-ci-wzxhzdk25">svn ci <version></h1>
+<p>...</p>
+<h1 id="exit">exit</h1>
+<p>$</p>
+<p>The packages should now be available on http://www.us.apache.org/dist/directory/mavibot/dist/<version></p>
+<h2 id="deploy-the-javadocs-and-xref">Deploy the Javadocs and XRef</h2>
+<p>We now can deploy the generated Javadoc and cross-reference pages. They are generated in the following directory :</p>
+<p>target/checkout/target/site</p>
+<p>We will copy two directories :</p>
+<div class="codehilite"><pre><span class="n">apidocs</span>
+<span class="n">xref</span>
+</pre></div>
+
+
+<h3 id="staging-or-production">Staging or Production?</h3>
+<p>Those files will be stored on the production server only !!! And some extra caution must be taken not to delete them when we will publish the staging site too...</p>
+<p>First of all, you must checkout the two CMS store for the site : staging and revision.</p>
+<p>$ cd ~/apacheds
+$ svn co https://svn.apache.org/repos/infra/websites/production/directory/trunk staging
+ ...
+$ svn co https://svn.apache.org/repos/infra/websites/production/directory production
+ ...</p>
+<p>Now, you will first add the directory for the newly generated version :</p>
+<p>$ cd ~/apacheds/production/content/mavibot/gen-docs
+$ mkdir <version>
+$ svn add <version></p>
+<p>Then copy the generated docs :</p>
+<p>$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/apidocs ~/apacheds/production/content/mavibot/gen-docs/<version>
+$ cp -r ~/apacheds/trunks/mavibot/target/checkout/target/site/xref ~/apacheds/production/content/mavibot/gen-docs/<version>
+$ </p>
+<p>You have to check in those directories :</p>
+<p>$ svn add <version>/*
+$ svn ci <version> -m "Injected <version> javadocs"</p>
+<p>Now, you have to update the staging site :
+extpaths.txt</p>
+<p>This file list the file on the production site that will not be overriden by the publication of the staging site. It has to be updated</p>
+<p>$ cd ~/apacheds/staging/content/
+$ vi extpaths.txt</p>
+<p>Add the following line :</p>
+<p>...</p>
+<h1 id="mavibot">Mavibot</h1>
+<p>mavibot/gen-docs/<version>
+...</p>
+<p>then save and check in the file
+.htaccess</p>
+<p>We also have to update this file :</p>
+<p>$ cd ~/apacheds/staging/content/mavibot/gen-docs
+$ vi .htaccess</p>
+<p>And update the two last lines to refer to the version you've just released :</p>
+<p>RewriteRule ^latest$ <version>/
+RewriteRule ^latest/(.*)$ <version>/$1</p>
+<p>Save and commit the file.</p>
+<h2 id="update-the-web-site">Update the web site</h2>
+<p>You can now update the site, add a news on the front page, and publish the site.</p>
+<h2 id="inform-the-world">Inform the world !</h2>
+<p>After 24h, you can now inform the world about the release.</p>
+<p>Send a mail to the users and dev mailing list, and one to the announce@apacge.org.</p>
+<p>You are done !</p>
+
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2012, <a href="http://www.apache.org">The Apache Software Foundation</a> - <a href="./../privacy-policy.html">Privacy Policy</a><br />
+ Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>