From: Paramat <paramat@users.noreply.github.com>
Date: Sat, 20 Jul 2019 01:54:42 +0000 (+0100)
Subject: Improve documentation of mapgen aliases (#8693)
X-Git-Tag: 5.1.0~171
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=9e005847302680dfc5c2fcadab81f5f1384db2d9;p=oweals%2Fminetest.git

Improve documentation of mapgen aliases (#8693)
---

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index be19d9e3d..c453a5dd2 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -286,7 +286,9 @@ of the game's nodes are to be used for core mapgen generation. For example:
 
     minetest.register_alias("mapgen_stone", "default:stone")
 
-### Aliases needed for all mapgens except Mapgen V6
+### Aliases for non-V6 mapgens
+
+#### Essential aliases
 
 * mapgen_stone
 * mapgen_water_source
@@ -296,17 +298,20 @@ of the game's nodes are to be used for core mapgen generation. For example:
 it is necessary to have a river liquid node with a short `liquid_range` and
 `liquid_renewable = false` to avoid flooding.
 
-#### Deprecated aliases
+#### Optional aliases
 
 * mapgen_lava_source
+
+Fallback lava node used if cave liquids are not defined in biome definitions.
+Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
+
 * mapgen_cobble
 
-Use biome-defined cave liquids and dungeon nodes instead.
+Fallback node used if dungeon nodes are not defined in biome definitions.
+Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
 
 ### Aliases needed for Mapgen V6
 
-#### Terrain and biomes
-
 * mapgen_stone
 * mapgen_water_source
 * mapgen_lava_source
@@ -321,8 +326,6 @@ Use biome-defined cave liquids and dungeon nodes instead.
 * mapgen_snow
 * mapgen_ice
 
-#### Flora
-
 * mapgen_tree
 * mapgen_leaves
 * mapgen_apple
@@ -332,8 +335,6 @@ Use biome-defined cave liquids and dungeon nodes instead.
 * mapgen_pine_tree
 * mapgen_pine_needles
 
-#### Dungeons
-
 * mapgen_cobble
 * mapgen_stair_cobble
 * mapgen_mossycobble