add checklist for releases

[nominatim.git] / docs / customize / Settings.md

diff --git a/docs/customize/Settings.md b/docs/customize/Settings.md
index a71b2e1b1f9fa66704e60db028ac39c31cbb5b1e..289433d6ee28388990b103b9deea85ffe13d5bc0 100644 (file)
--- a/docs/customize/Settings.md
+++ b/docs/customize/Settings.md
@@ -148,6 +148,29 @@ Setting this option to 'yes' means that Nominatim skips reindexing of contained
 objects when the area becomes too large.
 
 
 objects when the area becomes too large.
 
 

+#### NOMINATIM_UPDATE_FORWARD_DEPENDENCIES
+
+| Summary            |                                                     |
+| --------------     | --------------------------------------------------- |
+| **Description:**   | Forward geometry changes to dependet objects |
+| **Format:**        | bool |
+| **Default:**       | no |
+| **Comment:**       | EXPERT ONLY. Must not be enabled after import. |
+
+The geometry of OSM ways and relations may change when a node that is part
+of the object is moved around. These changes are not propagated per default.
+The geometry of ways/relations is only updated the next time that the object
+itself is touched. When enabling this option, then dependent objects will
+be marked for update when one of its member objects changes.
+
+Enabling this option may slow down updates significantly.
+
+!!! warning
+    If you want to enable this option, it must be set already on import.
+    Do not enable this option on an existing database that was imported with
+    NOMINATIM_UPDATE_FORWARD_DEPENDENCIES=no.
+    Updates will become unusably slow.
+

 #### NOMINATIM_LANGUAGES
 
 | Summary            |                                                     |
 #### NOMINATIM_LANGUAGES
 
 | Summary            |                                                     |


@@ -189,7 +212,7 @@ will be used.
 | **Description:**   | Enable searching for Tiger house number data |
 | **Format:**        | boolean |
 | **Default:**       | no |
 | **Description:**   | Enable searching for Tiger house number data |
 | **Format:**        | boolean |
 | **Default:**       | no |

-| **After Changes:** | run `nominatim --refresh --functions` |
+| **After Changes:** | run `nominatim refresh --functions` |

 
 When this setting is enabled, search and reverse queries also take data
 from [Tiger house number data](Tiger.md) into account.
 
 When this setting is enabled, search and reverse queries also take data
 from [Tiger house number data](Tiger.md) into account.


@@ -202,7 +225,7 @@ from [Tiger house number data](Tiger.md) into account.
 | **Description:**   | Enable searching in external house number tables |
 | **Format:**        | boolean |
 | **Default:**       | no |
 | **Description:**   | Enable searching in external house number tables |
 | **Format:**        | boolean |
 | **Default:**       | no |

-| **After Changes:** | run `nominatim --refresh --functions` |
+| **After Changes:** | run `nominatim refresh --functions` |

 | **Comment:**       | Do not use. |
 
 When this setting is enabled, search queries also take data from external
 | **Comment:**       | Do not use. |
 
 When this setting is enabled, search queries also take data from external


@@ -328,9 +351,13 @@ project directory and then in the global settings directory.
 | **Default:**       | extratags |
 
 The _style configuration_ describes which OSM objects and tags are taken
 | **Default:**       | extratags |
 
 The _style configuration_ describes which OSM objects and tags are taken

-into consideration for the search database. This setting may either
-be a string pointing to one of the internal styles or it may be a path
-pointing to a custom style.
+into consideration for the search database. Nominatim comes with a set
+of pre-configured styles, that may be configured here.
+
+You can also write your own custom style and point the setting to the file
+with the style. When a relative path is given, then the style file is searched
+first relative to the project directory and then in the global settings
+directory.

 
 See [Import Styles](Import-Styles.md)
 for more information on the available internal styles and the format of the
 
 See [Import Styles](Import-Styles.md)
 for more information on the available internal styles and the format of the


@@ -350,6 +377,9 @@ location for OSM nodes. For larger imports it can significantly speed up
 the import. When this option is unset, then osm2pgsql uses a PsotgreSQL table
 to store the locations.
 
 the import. When this option is unset, then osm2pgsql uses a PsotgreSQL table
 to store the locations.
 

+When a relative path is given, then the flatnode file is created/searched
+relative to the project directory.
+

 !!! warning
 
     The flatnode file is not only used during the initial import but also
 !!! warning
 
     The flatnode file is not only used during the initial import but also


@@ -627,7 +657,11 @@ Can be used as the same time as NOMINATIM_LOG_FILE.
 | **After Changes:** | run `nominatim refresh --website` |
 
 Enable logging of requests into a file with this setting by setting the log
 | **After Changes:** | run `nominatim refresh --website` |
 
 Enable logging of requests into a file with this setting by setting the log

-file where to log to. The entries in the log file have the following format:
+file where to log to. A relative file name is assumed to be relative to
+the project directory.
+
+
+The entries in the log file have the following format:

 
     <request time> <execution time in s> <number of results> <type> "<query string>"
 
 
     <request time> <execution time in s> <number of results> <type> "<query string>"