From 98dea7e4d6cc872ab03820ba7b480f101e4ea0e9 Mon Sep 17 00:00:00 2001
From: Jason van Zyl <jvanzyl@apache.org>
Date: Wed, 28 Feb 2007 18:23:03 +0000
Subject: [PATCH] o documentation for MNG-2835

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@512892 13f79535-47bb-0310-9956-ffa450edef68
---
 maven-embedder/src/site/apt/index.apt | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/maven-embedder/src/site/apt/index.apt b/maven-embedder/src/site/apt/index.apt
index b044fa37f8..7815a1e0b8 100644
--- a/maven-embedder/src/site/apt/index.apt
+++ b/maven-embedder/src/site/apt/index.apt
@@ -17,7 +17,29 @@ A Simple Example
 
 %{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.