From c3e81e0f45604b3387d1aa845fe1cb95a9c43bee Mon Sep 17 00:00:00 2001
From: Hans-Christoph Steiner <hans@eds.org>
Date: Wed, 2 Jun 2021 19:56:09 +0200
Subject: [PATCH] document constant that is used externally

refs #2147
---
 app/src/main/java/org/fdroid/fdroid/UpdateService.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/app/src/main/java/org/fdroid/fdroid/UpdateService.java b/app/src/main/java/org/fdroid/fdroid/UpdateService.java
index 3487e9980..1d0631289 100644
--- a/app/src/main/java/org/fdroid/fdroid/UpdateService.java
+++ b/app/src/main/java/org/fdroid/fdroid/UpdateService.java
@@ -81,6 +81,13 @@ public class UpdateService extends JobIntentService {
     public static final int STATUS_ERROR_LOCAL_SMALL = 4;
     public static final int STATUS_INFO = 5;
 
+    /**
+     * This number should never change, it is used by ROMs to trigger
+     * the first background update of F-Droid during setup.
+     *
+     * @see <a href="https://gitlab.com/fdroid/fdroidclient/-/issues/2147">Add a way to trigger an index update externally</a>
+     * @see <a href="https://review.calyxos.org/c/CalyxOS/platform_packages_apps_SetupWizard/+/3461"/>Schedule F-Droid index update on initialization and network connection</a>
+     */
     private static final int JOB_ID = 0xfedcba;
 
     private static final int NOTIFY_ID_UPDATING = 0;