documentation: clarify osm2pgsql isnt in project directory by default

[nominatim.git] / nominatim / clicmd / index.py

diff --git a/nominatim/clicmd/index.py b/nominatim/clicmd/index.py
index ea95e4565270a72dad8b9cdd2c609f51ee27a9d3..73258be2c1acaef71f8d8dea3f315933ef5fd8cf 100644 (file)
--- a/nominatim/clicmd/index.py
+++ b/nominatim/clicmd/index.py
@@ -1,3 +1,9 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 by the Nominatim developer community.
+# For a full list of authors see the git log.
 """
 Implementation of the 'index' subcommand.
 """
@@ -15,6 +21,11 @@ from nominatim.db.connection import connect
 class UpdateIndex:
     """\
     Reindex all new and modified data.
+
+    Indexing is the process of computing the address and search terms for
+    the places in the database. Every time data is added or changed, indexing
+    needs to be run. Imports and replication updates automatically take care
+    of indexing. For other cases, this function allows to run indexing manually.
     """
 
     @staticmethod