summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuca Milanesio <luca.milanesio@gmail.com>2021-11-26 14:52:00 +0000
committerLuca Milanesio <luca.milanesio@gmail.com>2021-11-26 14:52:00 +0000
commit4f5de60081d7c098d09c842e3ea9d5bc920df71b (patch)
tree3e983745e4bd0d0fb9f906e7c0d577facefdc967
parentaf3dee4dc18c47a60ab7a97333e87c98b8379173 (diff)
parent9a76d4505e0f327db5d2b2a650b1c1985c26077b (diff)
* stable-3.4: Doc: make explicit that remoteNameStyle is for non-Gerrit repos Doc: remoteNameStyle might result in a repo name clashes Change-Id: I77b698b5976dda82160ca967ce52e510791e651f
-rw-r--r--src/main/resources/Documentation/config.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index 5c8e2c7..d401030 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -510,7 +510,8 @@ remote.NAME.mirror
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
@@ -525,6 +526,14 @@ remote.NAME.remoteNameStyle
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.