Skip to content

Commit a0c399a

Browse files
committed
Tidy docs
1 parent 553d329 commit a0c399a

File tree

3 files changed

+8
-13
lines changed

3 files changed

+8
-13
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,17 +128,13 @@ Bug reports, suggestions and (especially!) pull requests are very welcome on the
128128

129129
Formatting: braces and indents as shown, hard tabs (4sp). (Yes, I know.) Please be conservative about adding dependencies or increasing the memory requirement.
130130

131-
To safely rebuild the project after making changes to the code, you need to run :
132-
133-
make clean
134-
make
135-
sudo make install
131+
The Makefile does not currently pick up changes to header files (.h). If you change these, you may need to run `make clean` before building with `make` and `sudo make install`.
136132

137133
## Copyright
138134

139135
tilemaker is maintained by Richard Fairhurst and supported by [many contributors](https://github.com/systemed/tilemaker/graphs/contributors). We particularly celebrate the invaluable contributions of Wouter van Kleunen, who passed away in 2022.
140136

141-
Copyright tilemaker contributors, 2015-2024.
137+
Copyright tilemaker contributors, 2015-2025.
142138

143139
The tilemaker code is licensed as FTWPL; you may do anything you like with this code and there is no warranty.
144140

docs/CONFIGURATION.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ It also includes these global settings:
3333
* `basezoom` - the zoom level for which tilemaker will generate tiles internally (should usually be the same as `maxzoom`)
3434
* `include_ids` - whether you want to store the OpenStreetMap IDs for each way/node within your vector tiles. This option is not compatible with the merging options defined by the `combine_xxx` settings (see the dedicated paragraph below)
3535
* `compress` - for mbtiles output, whether to compress vector tiles (Any of "gzip","deflate" or "none"(default)). For pmtiles output, compression is hardcoded to gzip
36-
* `combine_below` - whether to merge all linestrings in the tile with the same attributes: will be done at zoom levels below that specified here (e.g. `"combine_below": 14` to merge at z1-13). This global setting will be overridden by the layer-specific parameter `combine_lines_below` in layers where it has been defined (see below).
3736
* `name`, `version` and `description` - about your project (these are written into the MBTiles file)
3837
* `high_resolution` (optional) - whether to use extra coordinate precision at the maximum zoom level (makes tiles a bit bigger)
3938
* `bounding_box` (optional) - the bounding box to output, in [minlon, minlat, maxlon, maxlat] order
4039
* `default_view` (optional) - the default location for the client to view, in [lon, lat, zoom] order (MBTiles only)
4140
* `mvt_version` (optional) - the version of the [Mapbox Vector Tile](https://github.com/mapbox/vector-tile-spec) spec to use; defaults to 2
41+
* `combine_below` (deprecated) - whether to merge all linestrings in the tile with the same attributes: will be done at zoom levels below that specified here (e.g. `"combine_below": 14` to merge at z1-13). Please use the layer-specific parameter `combine_lines_below` instead.
4242

4343
A typical config file would look like this:
4444

@@ -119,12 +119,14 @@ For example:
119119

120120
### Including IDs
121121

122-
Be careful when using both the `include_ids: true` setting to include IDs and the `combine_xxx` settings to lighten tiles : they are not compatible. During the merging process, items with identical tags are combined in a collection, with only 1 ID being retained for all the merged items. If you need to have the exact ID for each item (for example, for a clickable map), you need to remove the merging settings in the target levels and layers:
122+
You can carry the original OpenStreetMap object ID through to each vector tile feature with the global `include_ids` option.
123+
124+
Note that this is not compatible with the `combine_xxx` settings to reduce tilesize. These settings merge items with identical tags into a collection, so only one ID will be retained for all the merged items. If you need to have the exact ID for each item, remove the merging settings in the target levels and layers:
123125

124126
* set `combine_points: false` (`true` is the default value) in the target layers
125-
* set `combine_below` in global settings, or `combine_lines_below` and `combine_polygons_below` in layer properties, below the target zoom level (or remove them)
127+
* set `combine_lines_below` and `combine_polygons_below` in layer properties below the target zoom level (or remove them)
126128

127-
If you need the include OSM types as well, you can use the `OsmType()`function in your `process.lua` script.
129+
If you need to include OSM object types as well, you can use the `OsmType()` function in your `process.lua` script.
128130

129131
## Lua processing reference
130132

src/shared_data.cpp

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,6 @@ void Config::readConfig(rapidjson::Document &jsonConfig, bool &hasClippingBox, B
349349
writeTo);
350350

351351
cout << "Layer " << layerName << " (z" << minZoom << "-" << maxZoom << ")";
352-
cout << " - combine points: " << combinePoints;
353-
cout << " - combine lines below " << combineLinesBelow;
354-
cout << " - combine polygons below " << combinePolyBelow;
355352
if (it->value.HasMember("write_to")) { cout << " -> " << it->value["write_to"].GetString(); }
356353
cout << endl;
357354
}

0 commit comments

Comments
 (0)