From e8c37f3a5016859cff387042e24981e5eb6773e2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Pfeuffer?= <rene.pfeuffer@cloudogu.com>
Date: Tue, 28 May 2019 08:12:31 +0200
Subject: [PATCH] Add doc

---
 .../repository/update/XmlRepositoryFileNameUpdateStep.java   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/scm-webapp/src/main/java/sonia/scm/repository/update/XmlRepositoryFileNameUpdateStep.java b/scm-webapp/src/main/java/sonia/scm/repository/update/XmlRepositoryFileNameUpdateStep.java
index aa6641f257..765f3c6317 100644
--- a/scm-webapp/src/main/java/sonia/scm/repository/update/XmlRepositoryFileNameUpdateStep.java
+++ b/scm-webapp/src/main/java/sonia/scm/repository/update/XmlRepositoryFileNameUpdateStep.java
@@ -16,6 +16,11 @@ import java.nio.file.Path;
 
 import static sonia.scm.version.Version.parse;
 
+/**
+ * Moves an existing <code>repositories.xml</code> file to <code>repository-paths.xml</code>.
+ * Note that this has to run <em>after</em> an old v1 repository database has been migrated to v2
+ * (see {@link XmlRepositoryV1UpdateStep}).
+ */
 @Extension
 public class XmlRepositoryFileNameUpdateStep implements UpdateStep {