Allow mirror to be created in directories specified by 'path' attribute

In some cases, especially when local manifest files exist, users may want
to force the mirrored repositories to be created in folders according to
their 'path' attribute in the manifest, rather than according to the name
of the repositories.

To enable this functionality for specified mirror, add a new attribute
'force-path' for that project in the manifest, set its value to 'true'.

Change-Id: I61df8c987a23d84309b113e7d886ec90c838a6cc
Signed-off-by: Scott Fan <fancp2007@gmail.com>

1 files changed, 7 insertions, 0 deletions

diff --git a/docs/manifest-format.txt b/docs/manifest-format.txt
index f4629a55..59f6a2fd 100644
--- a/docs/manifest-format.txt
+++ b/docs/manifest-format.txt
@@ -57,6 +57,7 @@ following DTD:
     <!ATTLIST project sync-s   CDATA #IMPLIED>
     <!ATTLIST project upstream CDATA #IMPLIED>
     <!ATTLIST project clone-depth CDATA #IMPLIED>
+    <!ATTLIST project force-path CDATA #IMPLIED>
 
     <!ELEMENT annotation (EMPTY)>
     <!ATTLIST annotation name  CDATA #REQUIRED>
@@ -227,6 +228,12 @@ Attribute `clone-depth`: Set the depth to use when fetching this
 project.  If specified, this value will override any value given
 to repo init with the --depth option on the command line.
 
+Attribute `force-path`: Set to true to force this project to create the
+local mirror repository according to its `path` attribute (if supplied)
+rather than the `name` attribute.  This attribute only applies to the
+local mirrors syncing, it will be ignored when syncing the projects in a
+client working directory.
+
 Element annotation
 ------------------