You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/04/23 16:10:40 UTC
svn commit: r164384 - in /maven/maven-1/core/trunk: maven.xml src/site/
src/site/developers/ src/site/developers/maven-codestyle.xml
xdocs/contributing/patches.xml xdocs/developers/code-style.xml
xdocs/navigation-pdf.xml xdocs/navigation.xml
Author: brett
Date: Sat Apr 23 07:10:39 2005
New Revision: 164384
URL: http://svn.apache.org/viewcvs?rev=164384&view=rev
Log:
add code style
Added:
maven/maven-1/core/trunk/src/site/
maven/maven-1/core/trunk/src/site/developers/
maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml (with props)
maven/maven-1/core/trunk/xdocs/developers/code-style.xml (with props)
Modified:
maven/maven-1/core/trunk/maven.xml
maven/maven-1/core/trunk/xdocs/contributing/patches.xml
maven/maven-1/core/trunk/xdocs/navigation-pdf.xml
maven/maven-1/core/trunk/xdocs/navigation.xml
Modified: maven/maven-1/core/trunk/maven.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/maven.xml?rev=164384&r1=164383&r2=164384&view=diff
==============================================================================
--- maven/maven-1/core/trunk/maven.xml (original)
+++ maven/maven-1/core/trunk/maven.xml Sat Apr 23 07:10:39 2005
@@ -423,5 +423,11 @@
${systemScope.setProperty('maven.repo.local','${prevRepoLocal}')}
${systemScope.setProperty('maven.repo.remote','${prevRepoRemote}')}
</goal>
+
+ <postGoal name="xdoc:copy-user-resources">
+ <ant:copy todir="${maven.docs.dest}">
+ <ant:fileset dir="${basedir}/src/site" />
+ </ant:copy>
+ </postGoal>
</project>
Added: maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml?rev=164384&view=auto
==============================================================================
--- maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml (added)
+++ maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml Sat Apr 23 07:10:39 2005
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<code_scheme name="maven">
+ <option name="KEEP_LINE_BREAKS" value="false" />
+ <option name="USE_SAME_INDENTS" value="false" />
+ <option name="JAVA_INDENT_OPTIONS">
+ <value>
+ <option name="INDENT_SIZE" value="4" />
+ <option name="CONTINUATION_INDENT_SIZE" value="4" />
+ <option name="TAB_SIZE" value="4" />
+ <option name="USE_TAB_CHARACTER" value="false" />
+ <option name="SMART_TABS" value="false" />
+ </value>
+ </option>
+ <option name="JSP_INDENT_OPTIONS">
+ <value>
+ <option name="INDENT_SIZE" value="2" />
+ <option name="CONTINUATION_INDENT_SIZE" value="4" />
+ <option name="TAB_SIZE" value="2" />
+ <option name="USE_TAB_CHARACTER" value="false" />
+ <option name="SMART_TABS" value="false" />
+ </value>
+ </option>
+ <option name="XML_INDENT_OPTIONS">
+ <value>
+ <option name="INDENT_SIZE" value="2" />
+ <option name="CONTINUATION_INDENT_SIZE" value="4" />
+ <option name="TAB_SIZE" value="2" />
+ <option name="USE_TAB_CHARACTER" value="false" />
+ <option name="SMART_TABS" value="false" />
+ </value>
+ </option>
+ <option name="LINE_SEPARATOR" value=" " />
+ <option name="BRACE_STYLE" value="2" />
+ <option name="CLASS_BRACE_STYLE" value="2" />
+ <option name="METHOD_BRACE_STYLE" value="2" />
+ <option name="ELSE_ON_NEW_LINE" value="true" />
+ <option name="WHILE_ON_NEW_LINE" value="true" />
+ <option name="CATCH_ON_NEW_LINE" value="true" />
+ <option name="FINALLY_ON_NEW_LINE" value="true" />
+ <option name="ALIGN_MULTILINE_PARAMETERS_IN_CALLS" value="true" />
+ <option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
+ <option name="BLANK_LINES_AROUND_FIELD" value="1" />
+ <option name="SPACE_WITHIN_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_METHOD_CALL_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_METHOD_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_IF_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_WHILE_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_FOR_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_CATCH_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_SWITCH_PARENTHESES" value="true" />
+ <option name="SPACE_WITHIN_SYNCHRONIZED_PARENTHESES" value="true" />
+ <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="999" />
+ <option name="CALL_PARAMETERS_WRAP" value="1" />
+ <option name="METHOD_PARAMETERS_WRAP" value="1" />
+ <option name="EXTENDS_LIST_WRAP" value="1" />
+ <option name="THROWS_LIST_WRAP" value="1" />
+ <option name="EXTENDS_KEYWORD_WRAP" value="2" />
+ <option name="THROWS_KEYWORD_WRAP" value="2" />
+ <option name="BINARY_OPERATION_WRAP" value="1" />
+ <option name="TERNARY_OPERATION_WRAP" value="1" />
+ <option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true" />
+ <option name="FOR_STATEMENT_WRAP" value="1" />
+ <option name="ARRAY_INITIALIZER_WRAP" value="1" />
+ <option name="ASSIGNMENT_WRAP" value="1" />
+ <option name="IF_BRACE_FORCE" value="3" />
+ <option name="DOWHILE_BRACE_FORCE" value="3" />
+ <option name="WHILE_BRACE_FORCE" value="3" />
+ <option name="FOR_BRACE_FORCE" value="3" />
+</code_scheme>
+
Propchange: maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml
------------------------------------------------------------------------------
svn:executable = *
Propchange: maven/maven-1/core/trunk/src/site/developers/maven-codestyle.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/core/trunk/xdocs/contributing/patches.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/contributing/patches.xml?rev=164384&r1=164383&r2=164384&view=diff
==============================================================================
--- maven/maven-1/core/trunk/xdocs/contributing/patches.xml (original)
+++ maven/maven-1/core/trunk/xdocs/contributing/patches.xml Sat Apr 23 07:10:39 2005
@@ -41,6 +41,11 @@
<code>due-to="Your Name"</code> attribute.
</p>
<p>
+ You should use the Maven code style for your contributions, and be careful to limit changes only to the
+ relevant areas of the submission. Some <a href="../developers/code-style.html">code style descriptors</a>
+ for different IDEs are also available.
+ </p>
+ <p>
Make sure any new files you've created that you want to add have had <code>svn add</code> run on them first.
</p>
<p>
Added: maven/maven-1/core/trunk/xdocs/developers/code-style.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/developers/code-style.xml?rev=164384&view=auto
==============================================================================
--- maven/maven-1/core/trunk/xdocs/developers/code-style.xml (added)
+++ maven/maven-1/core/trunk/xdocs/developers/code-style.xml Sat Apr 23 07:10:39 2005
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+ <properties>
+ <author email="brett@apache.org">Brett Porter</author>
+ <title>Maven Code Style</title>
+ </properties>
+
+ <body>
+ <section name="Maven Code Style">
+ <p>
+ The following sections show how to set up the code style for Maven in IDEA.
+ It is strongly preferred that patches use this style before they are spplied.
+ </p>
+ <subsection name="IntelliJ IDEA 4.5+">
+ <p>
+ Download <code><a href="maven-codestyle.xml">maven-codestyle.xml</a></code> and copy it to
+ <code>~/.IntelliJIDEA/config/codestyles</code> then restart IDEA. On Windows, try
+ <code>C:\Documents and Settings\<i>username</i>\.IntelliJIDEA\config\codestyles</code>.
+ </p>
+ <p>
+ After this, restart IDEA and open the settings to select the new code style.
+ </p>
+ </subsection>
+ <!-- TODO: include sample -->
+ </section>
+ </body>
+</document>
+
+
Propchange: maven/maven-1/core/trunk/xdocs/developers/code-style.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/core/trunk/xdocs/developers/code-style.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/core/trunk/xdocs/navigation-pdf.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation-pdf.xml?rev=164384&r1=164383&r2=164384&view=diff
==============================================================================
--- maven/maven-1/core/trunk/xdocs/navigation-pdf.xml (original)
+++ maven/maven-1/core/trunk/xdocs/navigation-pdf.xml Sat Apr 23 07:10:39 2005
@@ -138,6 +138,7 @@
<menu name="Developers" type="footer">
<item name="Documenting" href="/developers/documentation-conventions.html" />
<item name="Making Releases" href="/developers/making-releases.html" />
+ <item name="Code Style" href="/developers/code-style.html" />
<item name="Apache Resources" href="/developers/apache.html" />
</menu>
Modified: maven/maven-1/core/trunk/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation.xml?rev=164384&r1=164383&r2=164384&view=diff
==============================================================================
--- maven/maven-1/core/trunk/xdocs/navigation.xml (original)
+++ maven/maven-1/core/trunk/xdocs/navigation.xml Sat Apr 23 07:10:39 2005
@@ -139,6 +139,7 @@
<menu name="Developers" type="footer">
<item name="Documenting" href="/developers/documentation-conventions.html" />
<item name="Making Releases" href="/developers/making-releases.html" />
+ <item name="Code Style" href="/developers/code-style.html" />
<item name="Apache Resources" href="/developers/apache.html" />
</menu>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org