Doc: remoteNameStyle might result in a repo name clashes
When using the remoteNameStyle in the replication.config settings
the Gerrit admin needs to be warned on the risks of using sytles
that may be ambiguous and associate two source repositories to
the same target repository on the replica.
Example: set remoteNameStyle to basenameOnly
/foo/my-repo.git => pushed to my-repo
/bar/my-repo.git => pushed to my-repo
When two commits are pushed to the same branch on the two repos
/foo/my-repo.git and /bar/my-repo.git, the replication plugin
would push them to the same target repo my-repo, causing clashes
and losing commits (depending which one is pushed first).
The risk needs to be highlighted so that the Gerrit admin
can check that univocity of the mapping is respected.
Bug: Issue 15315
Change-Id: Iba42907bceb8d1c27d739f3b0cded4a1d7400686
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index d606b7b..60a7792 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -449,6 +449,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.
