Merge branch 'stable-3.3' into stable-3.4 * stable-3.3: Doc: make explicit that remoteNameStyle is for non-Gerrit repos Doc: remoteNameStyle might result in a repo name clashes Change-Id: I1b2e9c5fd408b8f8bd1a3ef3104182c6f6474559
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index f4ea9d6..af91032 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -443,7 +443,8 @@ remote.NAME.remoteNameStyle : Provides possibilities to influence the name of the target repository, e.g. by replacing slashes in the `${name}` - placeholder. + placeholder, when the target remote repository is not served + by Gerrit. Github and Gitorious do not permit slashes "/" in repository names and will change them to dashes "-" at repository creation @@ -458,6 +459,14 @@ Gerrit server, e.g. `${name}` of `foo/bar/my-repo.git` would be `my-repo`. + > **NOTE**: The use of repository name translation using `remoteNameStyle` + > may lead to dangerous situations if there are multiple repositories + > that may be mapped to the same target name. For instance when + > mapping `/foo/my-repo.git` to `my-repo` using "basenameOnly" + > would also map `/bar/my-repo.git` to the same `my-repo` leading + > to conflicts where commits can be lost between the two repositories + > replicating to the same target `my-repo`. + By default, "slash", i.e. remote names will contain slashes as they do in Gerrit.