svn commit: r512892 - /maven/components/trunk/maven-embedder/src/site/apt/index.apt

[jv...@apache.org]

Author: jvanzyl
Date: Wed Feb 28 10:23:03 2007
New Revision: 512892

URL: http://svn.apache.org/viewvc?view=rev&rev=512892
Log:
o documentation for MNG-2835

Modified:
    maven/components/trunk/maven-embedder/src/site/apt/index.apt

Modified: maven/components/trunk/maven-embedder/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-embedder/src/site/apt/index.apt?view=diff&rev=512892&r1=512891&r2=512892
==============================================================================
--- maven/components/trunk/maven-embedder/src/site/apt/index.apt (original)
+++ maven/components/trunk/maven-embedder/src/site/apt/index.apt Wed Feb 28 10:23:03 2007
@@ -17,7 +17,29 @@
 
 %{snippet|id=simple-embedder-example|url=http://svn.apache.org/repos/asf/maven/components/trunk/maven-embedder/src/test/java/org/apache/maven/embedder/MavenEmbedderExampleTest.java}
 
+A Note on Configuring Settings
 
+ Currently there is a notion of a user settings, and a global settings where either can specify information about the
+ following:
+
+ * Local Repository
+
+ * Proxies
+
+ * Mirrors
+
+ * Server Configurations
+
+ * Plugin Groups
+
+ If you are using the embedder it is entirely your responsibility to take user and global settings information and specify
+ it in the embedder configuration. The embedder carries with it <<<no>>> defaults about where these are located and how
+ they are used. If you want your embedded use of Maven to mimic the behavior of the Maven CLI insofar as settings use
+ then use the following code:
+
+ %{snippet|id=mimic-cli|url=http://svn.apache.org/repos/asf/maven/components/trunk/maven-embedder/src/test/java/org/apache/maven/embedder/MavenEmbedderExampleTest.java}
+
+  Also note that the user and global settings are merged, and the user settings are dominant.