From 346f8ef24e095c86ff723bec0b912c34ed2bd835 Mon Sep 17 00:00:00 2001 From: Rogier Date: Thu, 17 Dec 2015 14:04:35 +0100 Subject: [PATCH] Document the different reported world statistics (geometries) in manual. (these are reported with --verbose and --verbose=2) --- Changelog | 1 + doc/manual.rst | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/Changelog b/Changelog index 0cd70bc..6ebff94 100644 --- a/Changelog +++ b/Changelog @@ -10,6 +10,7 @@ - HTML versions of documentation in doc/ is now generated, and included in the different packages. - Documented concurrent minetest & minetestmapper use. + - Documented the different geometries reported with --verbose Bugfixes: - Fixed possible compilation failure caused by stdint.h - Fixed compilation failure when some database libraries are not installed diff --git a/doc/manual.rst b/doc/manual.rst index 4ab0cf9..ab7edc5 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -1203,6 +1203,30 @@ Detailed Description of Options Using `--verbose=3`, report statistics about block formats found in the database (currently only applicable to leveldb) + Description of possible reported coordinates. Only the values that are + applicable and available are printed. + + :Command-line Geometry: The geometry specified on the command-line, before + aligning to map-blocks. + If none, then the maximum possible geometry. + :Requested Geometry: The effective geometry requested on the command-line + (i.e. after aligninment to map-blocks due to the + requested or implicit granularity). + If none, then the maximum possible geometry. + :Adjusted Geometry: The geometry after adjustment required by scaling. + :Block-aligned Geometry: The geometry of the area to be loaded from the database + (i.e. extended to map-block boundaries). + :World Geometry: The geometry of the entire existing world found in + the database. + :Minimal Map Geometry: The minimal possible geometry that shows the same + information as the requested geometry. + :Map Vertical Limits: Vertical limits of the world in the area being mapped. + :Map Output Geometry: The Geometry of the map that will be generated. + :Mapped Vertical Range: The actual vertical limits of the blocks that were mapped. + (I.e. excluding air and underground blocks that are not + visible) + This range is currently reported with block granularity. + ``--version`` ............. Report the version of this instance of minetestmapper.