Skip to content

Commit db3a383

Browse files
committed
update CMake notes [build_translation]
1 parent 9cd93f3 commit db3a383

5 files changed

Lines changed: 82 additions & 69 deletions

File tree

en/MIGRATION_GUIDE.txt

Lines changed: 61 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
MapServer Migration Guide
77
*****************************************************************************
88

9-
:Last Updated: 2026-04-19
9+
:Last Updated: 2026-05-01
1010

1111
.. contents:: Table of Contents
1212
:depth: 2
@@ -117,7 +117,7 @@ MapServer 8.4 to 8.6 Migration
117117
query parameters to all URLs generated through the API, by
118118
defining the `ows_extra_params` parameter in the mapfile's WEB.METADATA object.
119119

120-
.. code-block:: mapfile
120+
.. code-block:: mapfile
121121

122122
MAP
123123
...
@@ -155,6 +155,9 @@ MapServer 8.2 to 8.4 Migration
155155
an OGR backend connection (see CVE record: `CVE-2025-59431 <https://www.cve.org/CVERecord?id=CVE-2025-59431>`__,
156156
or MapServer's `Security Advisory <https://github.com/MapServer/MapServer/security/advisories/GHSA-256m-rx4h-r55w>`__)
157157

158+
- MapServer now requires at least `CMake <https://cmake.org/>`__ version 3.16
159+
for building
160+
158161
- you can now build against the PCRE2 library (WITH_PCRE2=ON)
159162

160163
- reminder that since the PROJ 9.1 release, the former `PROJ_LIB` variable has
@@ -346,7 +349,8 @@ MapServer 7.6 to 8.0 Migration
346349
MapServer 7.4 to 7.6 Migration
347350
==============================
348351

349-
- MapServer now requires at least CMake version 3.0 for compiling
352+
- MapServer now requires at least `CMake <https://cmake.org/>`__ version 3.0
353+
for building
350354

351355
- PointZM data support (X,Y,Z,M coordinates) is now enabled by default
352356

@@ -364,7 +368,7 @@ MapServer 7.4 to 7.6 Migration
364368
- CONNECTIONOPTIONS parameter has been added in the mapfile LAYER, to take
365369
advantage of GDAL/OGR driver options. (see :ref:`RFC 125 <rfc125>`) such as:
366370

367-
.. code-block:: mapfile
371+
.. code-block:: mapfile
368372

369373
LAYER
370374
NAME "test"
@@ -380,7 +384,7 @@ MapServer 7.4 to 7.6 Migration
380384
to enable a 'painters model' where all classes for a layer are drawn at once with a
381385
`ALL_MATCHING_CLASSES` setting, such as:
382386

383-
.. code-block:: mapfile
387+
.. code-block:: mapfile
384388

385389
LAYER
386390
NAME "test"
@@ -417,7 +421,7 @@ MapServer 7.4 to 7.6 Migration
417421

418422
Here is an example of the new `wms_essential` parameter:
419423

420-
.. code-block:: mapfile
424+
.. code-block:: mapfile
421425

422426
LAYER
423427
NAME "country_bounds"
@@ -437,7 +441,7 @@ MapServer 7.4 to 7.6 Migration
437441
- Windows users can now use umlauts (special characters such as ä ö ü) in their
438442
directory paths and filenames, such as:
439443

440-
.. code-block:: mapfile
444+
.. code-block:: mapfile
441445

442446
LAYER
443447
..
@@ -502,19 +506,19 @@ MapServer 6.4 to 7.0 Migration
502506
from MapServer syntax to native syntax (e.g. SQL). Native expressions can still be set either
503507
using: 1) sub-selects in the DATA statement or 2) using the new NATIVE_FILTER processing key.
504508

505-
::
509+
.. code-block:: mapfile
506510

507-
# OGR Layer Before
508-
LAYER
509-
...
510-
FILTER 'where id=234'
511-
END
511+
# OGR Layer Before
512+
LAYER
513+
...
514+
FILTER 'where id=234'
515+
END
512516

513-
# OGR Layer After
514-
LAYER
515-
...
516-
PROCESSING 'NATIVE_FILTER=id=234'
517-
END
517+
# OGR Layer After
518+
LAYER
519+
...
520+
PROCESSING 'NATIVE_FILTER=id=234'
521+
END
518522

519523
- MapServer attribute queries (e.g. mode=item[n]query) *must* be specified using MapServer
520524
expression syntax (qstring and qitem (opt)). For RDBMS backends you no longer send SQL snippets,
@@ -526,21 +530,21 @@ MapServer 6.4 to 7.0 Migration
526530
and MapScript getter/setter functions will continue to function but unpredictable results will
527531
occur if used in conjunction with COMPOSITE blocks. For more information see https://mapserver.org/development/rfc/ms-rfc-113.html.
528532

529-
::
530-
531-
# Before
532-
LAYER
533-
...
534-
OPACITY 70
535-
END
533+
.. code-block:: mapfile
536534

537-
# After
538-
LAYER
539-
...
540-
COMPOSITE
535+
# Before
536+
LAYER
537+
...
541538
OPACITY 70
542539
END
543-
END
540+
541+
# After
542+
LAYER
543+
...
544+
COMPOSITE
545+
OPACITY 70
546+
END
547+
END
544548

545549
- Handling of non UTF-8 encoded datasources has changed with RFC103. Mapfiles
546550
now *must* be saved in UTF-8 encoding, and requests returned by MapServer
@@ -567,38 +571,40 @@ MapServer 6.4 to 7.0 Migration
567571
- ExternalGraphics added through SLD must now validate against the
568572
"sld_external_graphic" entry of the MAP->WEB->VALIDATION block
569573

570-
::
574+
.. code-block:: mapfile
571575

572-
MAP
573-
WEB
574-
VALIDATION
575-
"sld_external_graphic" "^/path/to/symbols/.*png"
576+
MAP
577+
WEB
578+
VALIDATION
579+
"sld_external_graphic" "^/path/to/symbols/.*png"
580+
END
581+
END
576582
END
577-
END
578-
END
579583

580584
MapServer 6.2 to 6.4 Migration
581585
==============================
582586

587+
- MapServer now must be built with the CMake tool. Build instructions
588+
are included in the `INSTALL_CMAKE.md <https://github.com/MapServer/MapServer/blob/main/INSTALL_CMAKE.md>`__
589+
file in the source directory. You will need to have CMake installed
590+
on your system. Users of mapscripts (except PHP) will also need `SWIG <https://www.swig.org/>`__
591+
to be installed.
592+
583593
- The "ows_extent" layer metadata is not used anymore to obtain georeferencing
584594
information for unreferenced raster data. Please use the "extent" layer key
585595
instead
586596

587-
::
597+
.. code-block:: mapfile
588598

589-
LAYER
590-
...
591-
EXTENT -180 90 180 90
592-
END
599+
LAYER
600+
...
601+
EXTENT -180 90 180 90
602+
END
593603

594604
- Validation patterns cannot be specified in metadata blocks (i.e. using
595605
xxx_validation_pattern and default_xxx metadata entries), use VALIDATION blocks.
596606
see #4596 #4604 #4608 or :ref:`runsub`
597607

598-
- Build has changed after the switch to cmake. Build instructions are included in
599-
the INSTALL.CMAKE file in the source directory. You will need to have cmake installed
600-
on your system. Users of mapscripts (except php) will also need swig to be installed.
601-
602608
- WFS paging parameter startIndex changed to base on 0 instead of 1 (0 is the first
603609
feature). See #4180 for external references.
604610

@@ -726,7 +732,7 @@ support it.
726732
As a result the parameters BACKGROUNDCOLOR, BACKGROUNDSHADOWCOLOR, BACKGROUNDSHADOWSIZE
727733
are no more. To draw a label "box" in 6.0 you'd do:
728734

729-
::
735+
.. code-block:: mapfile
730736

731737
LABEL
732738
...
@@ -850,7 +856,9 @@ Mapfile Changes - OGC requests - DUMP parameter removed
850856
The DUMP LAYER parameter has been removed. To enable output of
851857
geometries in WMS getfeatureinfo requests - GML
852858
(INFO_FORMAT=application/vnd.ogc.gml), LAYER METADATA is used
853-
instead::
859+
instead.
860+
861+
.. code-block:: mapfile
854862

855863
METADATA
856864
gml_geometries "geom"
@@ -877,7 +885,7 @@ following character is ", ' or \.
877885
For Windows users: if you have a path string delimited by single/double
878886
quotes that ends with \, you will have to escape the last backslash.
879887

880-
::
888+
.. code-block:: mapfile
881889

882890
SHAPEPATH "C:\ms4w\shapefiles\"
883891
# should be modified to...
@@ -965,7 +973,7 @@ the 5.4/5.6 versions. Gone are resultsGetShape and getFeature methods. You shoul
965973
refactored getShape method to access layer shapes. That method takes a resultObj and returns
966974
a shapeObj. Typical use would be (in Perl):
967975

968-
::
976+
.. code-block:: perl
969977

970978
$layer->queryByRect($map, $map->{extent}); # layer is still open
971979

@@ -981,6 +989,8 @@ A resultObj encapsulates the data used to manage a result set.
981989

982990
To access shapes independently of a query use the new resultObj class:
983991

992+
.. code-block:: perl
993+
984994
$layer->open();
985995
$shape = $layer->getShape(new mapscript::resultObj(1));
986996
$layer->close();
@@ -1142,7 +1152,7 @@ like ANGLEITEM or LABELSIZEITEM were used, now you denote the attribute
11421152
in the context of the property being bound. For example, to bind an
11431153
attribute to a label size you'd do:
11441154

1145-
::
1155+
.. code-block:: mapfile
11461156

11471157
LABEL
11481158
...

en/installation/unix.txt

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
:Contact: thomas.bonfort at gmail.com
1414
:Author: Jeff McKenna
1515
:Contact: jmckenna at gatewaygeomatics.com
16-
:Last Updated: 2025-04-14
16+
:Last Updated: 2026-05-01
1717

1818
.. contents:: Table of Contents
1919
:depth: 2
@@ -24,23 +24,23 @@
2424
Introduction
2525
=============================================================================
2626

27-
The University of Minnesota's MapServer is an open-source and freely
28-
available map rendering engine for the web. Due to its open-source nature,
27+
The University of Minnesota's MapServer is an Open Source and freely
28+
available map rendering engine for the web. Due to its Open Source nature,
2929
it can be compiled on a wide variety of platforms and operating systems.
3030
We will focus on how to obtain, compile and install MapServer on UNIX-like
3131
platforms.
3232

3333
.. note::
3434

35-
Detailed configuration options are maintained in the `INSTALL.CMAKE`_
35+
Detailed configuration options are maintained in the `INSTALL_CMAKE.md`_
3636
file packaged at the root of the source directory:
3737

3838
.. tip::
3939

40-
The minimum CMake version required is 3.0 as of the MapServer 7.6.0 release
40+
The minimum CMake version required is 3.16 as of the MapServer 8.4.0 release
4141

42-
You might also check the `MapServerCompilation`_ wiki page for
43-
additional information.
42+
The old `MapServerCompilation`_ wiki page contains outdated information, but
43+
could be useful for early versions of MapServer.
4444

4545
=============================================================================
4646
Compiler Requirements
@@ -133,8 +133,8 @@ environment variables to secure your server are listed in :ref:`environment_vari
133133
within the PostgreSQL database. Ideally, your client library
134134
matches the database you are querying from.
135135

136-
* `giflib`_: libgif / `libgif`_ is is used for reading GIF files used
137-
as PIXMAP symbols.
136+
* `giflib`_: GIFLIB (or on some platforms "libgif") is used for reading
137+
GIF files used as PIXMAP symbols.
138138

139139
* `FastCGI`_: FastCGI is a popular protocol for interfacing MapServer
140140
with various web servers. You will need to install the development
@@ -580,27 +580,26 @@ server configuration isn't right:
580580
The :ref:`introduction` document provides excellent coverage of getting started
581581
with MapServer.
582582

583-
.. _`INSTALL.CMAKE`: https://github.com/MapServer/MapServer/blob/main/INSTALL.CMAKE
584-
.. _`MapServerCompilation`: https://trac.osgeo.org/mapserver/wiki/MapServerCompilation
583+
.. _`INSTALL_CMAKE.md`: https://github.com/MapServer/MapServer/blob/main/INSTALL_CMAKE.md
584+
.. _`MapServerCompilation`: https://web.archive.org/web/20240625061519/https://trac.osgeo.org/mapserver/wiki/MapServerCompilation
585585
.. _`libpng`: http://www.libpng.org/pub/png/libpng.html
586586
.. _`FreeType`: https://freetype.org/
587587
.. _`libjpeg`: https://www.ijg.org/
588588
.. _`zlib`: https://zlib.net/
589589
.. _`PROJ`: https://proj.org
590590
.. _`libcurl`: https://curl.se/libcurl/
591591
.. _`GDAL`: https://gdal.org/
592-
.. _`GEOS`: https://trac.osgeo.org/geos/
593-
.. _`libxml`: http://xmlsoft.org
594-
.. _`Oracle Spatial OCI`: https://www.oracle.com/ca-en/database/technologies/instant-client/downloads.html
592+
.. _`GEOS`: https://libgeos.org/
593+
.. _`libxml`: https://gitlab.gnome.org/GNOME/libxml2/-/wikis/home
594+
.. _`Oracle Spatial OCI`: https://www.oracle.com/database/technologies/instant-client/downloads.html
595595
.. _`libpq`: https://www.postgresql.org/
596596
.. _`giflib`: https://giflib.sourceforge.net/
597597
.. _`FastCGI`: https://fastcgi-archives.github.io/
598598
.. _`Cairo (SVG, PDF) support`: https://www.cairographics.org/
599599
.. _`Cairo SVG parser support`: https://mapserver.org/development/rfc/ms-rfc-73.html
600600
.. _`OGC`: https://www.ogc.org
601601
.. _`PostGIS`: https://postgis.net/
602-
.. _`setting up cgi-bin`: https://httpd.apache.org/docs/2.2/howto/cgi.html
602+
.. _`setting up cgi-bin`: https://httpd.apache.org/docs/current/howto/cgi.html
603603
.. _`PostgreSQL`: https://www.postgresql.org/
604-
.. _`libgif`: https://launchpad.net/ubuntu/precise/+package/libgif-dev
605604
.. _`HarfBuzz`: https://github.com/harfbuzz/harfbuzz
606605
.. _`FriBidi`: https://github.com/fribidi/fribidi

en/installation/win32.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ these files.
115115

116116
.. _`7-Zip`: https://www.7-zip.org/
117117

118-
Cygwin is a free, open-source software package which is a port of these tools
118+
Cygwin is a free, Open Source software package which is a port of these tools
119119
on Windows. You can use the gzip and tar utilities from this tool collection.
120120
Cygwin is available from
121121
https://www.cygwin.com.

en/optimization/raster.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Here are some other points to consider:
3333

3434
- For GeoTIFFs larger than 1 GB, ECW images tend to render faster than GeoTIFFs, since
3535
decompressing the data (CPU and RAM) is faster than reading the uncompressed
36-
data (disk). The downside is that ECW is not open-source, and the licensing is
36+
data (disk). The downside is that ECW is not Open Source, and the licensing is
3737
often prohibitive. `MrSID <https://gdal.org/drivers/raster/mrsid.html#raster-mrsid>`__
3838
is another compressed image format that can be used.
3939

en/spelling_wordlist.dict

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ bugfix
4141
bugfixes
4242
cairo
4343
cartesian
44+
catchable
4445
cellsize
4546
centerline
4647
centre
@@ -53,6 +54,7 @@ checkboxes
5354
classindex
5455
classitem
5556
classObj
57+
cloneable
5658
clusterObj
5759
cmake
5860
CMake
@@ -215,6 +217,7 @@ imageCRS
215217
imagemap
216218
imagemaps
217219
imagemode
220+
imageObj
218221
imagepath
219222
imagetype
220223
imageurl
@@ -353,6 +356,7 @@ nilvalue
353356
nilvalues
354357
nmake
355358
nquery
359+
nquerymap
356360
ntlm
357361
occurances
358362
oci

0 commit comments

Comments
 (0)