Use built_in_by_default and build_dependencies directive for vector …

…drivers (#2083) [skip travis] [skip appveyor]
OSGeo · Dec 3, 2019 · c4d3585 · c4d3585
1 parent aa38907
commit c4d3585
Show file tree

Hide file tree

Showing 101 changed files with 196 additions and 5 deletions.
diff --git a/gdal/doc/source/drivers/raster/cad.rst b/gdal/doc/source/drivers/raster/cad.rst
@@ -8,7 +8,7 @@ CAD -- AutoCAD DWG raster layer
 
 .. versionadded:: 2.2
 
-.. built_in_by_default:: (internal libopencad provided)
+.. build_dependencies:: (internal libopencad provided)
 
 OGR DWG support is based on libopencad, so the list of supported DWG
 (DXF) versions can be seen in libopencad documentation. All drawing

diff --git a/gdal/doc/source/drivers/raster/gif.rst b/gdal/doc/source/drivers/raster/gif.rst
@@ -6,7 +6,7 @@ GIF -- Graphics Interchange Format
 
 .. shortname:: GIF
 
-.. built_in_by_default:: (internal GIF library provided)
+.. build_dependencies:: (internal GIF library provided)
 
 GDAL supports reading and writing of normal, and interlaced GIF files.
 Gif files always appear as having one colormapped eight bit band. GIF

diff --git a/gdal/doc/source/drivers/raster/jpeg.rst b/gdal/doc/source/drivers/raster/jpeg.rst
@@ -6,7 +6,7 @@ JPEG -- JPEG JFIF File Format
 
 .. shortname:: JPEG
 
-.. built_in_by_default:: (internal libjpeg provided)
+.. build_dependencies:: (internal libjpeg provided)
 
 The JPEG JFIF format is supported for reading, and batch writing, but
 not update in place. JPEG files are represented as one band (greyscale)

diff --git a/gdal/doc/source/drivers/raster/pcraster.rst b/gdal/doc/source/drivers/raster/pcraster.rst
@@ -6,7 +6,7 @@ PCRaster -- PCRaster raster file format
 
 .. shortname:: PCRaster
 
-.. built_in_by_default:: (internal libcf provided)
+.. build_dependencies:: (internal libcf provided)
 
 GDAL includes support for reading and writing PCRaster raster files.
 PCRaster is a dynamic modeling system for distributed simulation models.

diff --git a/gdal/doc/source/drivers/raster/rik.rst b/gdal/doc/source/drivers/raster/rik.rst
@@ -6,7 +6,7 @@ RIK -- Swedish Grid Maps
 
 .. shortname:: RIK
 
-.. built_in_by_default:: (internal zlib is used if necessary)
+.. build_dependencies:: (internal zlib is used if necessary)
 
 Supported by GDAL for read access. This format is used in maps issued by
 the swedish organization Lantmäteriet. Supports versions 1, 2 and 3 of

diff --git a/gdal/doc/source/drivers/vector/aeronavfaa.rst b/gdal/doc/source/drivers/vector/aeronavfaa.rst
@@ -6,6 +6,8 @@ Aeronav FAA
 
 .. shortname:: AERONAVFAA
 
+.. built_in_by_default::
+
 This driver reads text files describing aeronav information - obstacles,
 navaids and routes - as provided by the FAA.
 

diff --git a/gdal/doc/source/drivers/vector/amigocloud.rst b/gdal/doc/source/drivers/vector/amigocloud.rst
@@ -8,6 +8,8 @@ AmigoCloud
 
 .. shortname:: AmigoCloud
 
+.. build_dependencies:: libcurl
+
 This driver can connect to the AmigoCloud API services. GDAL/OGR must be built
 with Curl support in order for the AmigoCloud driver to be compiled.
 

diff --git a/gdal/doc/source/drivers/vector/ao.rst b/gdal/doc/source/drivers/vector/ao.rst
@@ -6,6 +6,8 @@ ESRI ArcObjects
 
 .. shortname:: AO
 
+.. build_dependencies:: ESRI ArcObjects
+
 Overview
 --------
 

diff --git a/gdal/doc/source/drivers/vector/arcgen.rst b/gdal/doc/source/drivers/vector/arcgen.rst
@@ -6,6 +6,8 @@ ARCGEN - Arc/Info Generate
 
 .. shortname:: ARCGEN
 
+.. built_in_by_default::
+
 This driver reads files in Arc/Info Generate format. Those files are simple
 ASCII files that contain points, lines or polygons (one type of geometry per
 file).

diff --git a/gdal/doc/source/drivers/vector/avcbin.rst b/gdal/doc/source/drivers/vector/avcbin.rst
@@ -6,6 +6,8 @@ Arc/Info Binary Coverage
 
 .. shortname:: AVCBIN
 
+.. built_in_by_default::
+
 Arc/Info Binary Coverages (eg. Arc/Info V7 and earlier) are supported by OGR
 for read access.
 

diff --git a/gdal/doc/source/drivers/vector/avce00.rst b/gdal/doc/source/drivers/vector/avce00.rst
@@ -6,6 +6,8 @@ Arc/Info E00 (ASCII) Coverage
 
 .. shortname:: AVCE00
 
+.. built_in_by_default::
+
 Arc/Info E00 Coverages (eg. Arc/Info V7 and earlier) are supported by OGR for
 read access.
 

diff --git a/gdal/doc/source/drivers/vector/bna.rst b/gdal/doc/source/drivers/vector/bna.rst
@@ -6,6 +6,8 @@ BNA - Atlas BNA
 
 .. shortname:: BNA
 
+.. built_in_by_default::
+
 The BNA format is an ASCII exchange format for 2D vector data supported by many
 software packages. It only contains geometry and a few identifiers per record.
 Attributes must be stored into external files. It does not support any

diff --git a/gdal/doc/source/drivers/vector/cad.rst b/gdal/doc/source/drivers/vector/cad.rst
@@ -6,6 +6,8 @@ CAD -- AutoCAD DWG
 
 .. shortname:: CAD
 
+.. build_dependencies:: (internal libopencad provided)
+
 OGR DWG support is based on libopencad, so the list of supported DWG (DXF)
 versions can be seen in libopencad documentation. All drawing entities are
 separated into layers as they are in DWG file, not in 1 layer as DXF Driver

diff --git a/gdal/doc/source/drivers/vector/carto.rst b/gdal/doc/source/drivers/vector/carto.rst
@@ -6,6 +6,8 @@ Carto
 
 .. shortname:: CARTO
 
+.. build_dependencies:: libcurl
+
 This driver can connect to the services implementing the Carto API. GDAL/OGR
 must be built with Curl support in order for the Carto driver to be compiled.
 

diff --git a/gdal/doc/source/drivers/vector/cloudant.rst b/gdal/doc/source/drivers/vector/cloudant.rst
@@ -5,6 +5,8 @@ Cloudant -- Cloudant
 
 .. shortname:: Cloudant
 
+.. build_dependencies:: libcurl
+
 Cloudant and CouchDB are API compatible and based on the same core
 technology. The geospatial extension for Cloudant is separate to
 GeoCouch. This driver can connect to the a Cloudant service, potentially

diff --git a/gdal/doc/source/drivers/vector/couchdb.rst b/gdal/doc/source/drivers/vector/couchdb.rst
@@ -5,6 +5,8 @@ CouchDB - CouchDB/GeoCouch
 
 .. shortname:: CouchDB
 
+.. build_dependencies:: lilbcurl
+
 This driver can connect to the a CouchDB service, potentially enabled
 with the GeoCouch spatial extension.
 

diff --git a/gdal/doc/source/drivers/vector/csv.rst b/gdal/doc/source/drivers/vector/csv.rst
@@ -5,6 +5,8 @@ Comma Separated Value (.csv)
 
 .. shortname:: CSV
 
+.. built_in_by_default::
+
 OGR supports reading and writing primarily non-spatial tabular data
 stored in text CSV files. CSV files are a common interchange format
 between software packages supporting tabular data and are also easily

diff --git a/gdal/doc/source/drivers/vector/csw.rst b/gdal/doc/source/drivers/vector/csw.rst
@@ -5,6 +5,8 @@ CSW - OGC CSW (Catalog Service for the Web)
 
 .. shortname:: CSW
 
+.. build_dependencies:: libcurl
+
 This driver can connect to a OGC CSW service. It supports CSW 2.0.2
 protocol. GDAL/OGR must be built with Curl support in order to the CSW
 driver to be compiled. And the GML driver should be set-up for read

diff --git a/gdal/doc/source/drivers/vector/db2.rst b/gdal/doc/source/drivers/vector/db2.rst
@@ -5,6 +5,8 @@ DB2 Spatial
 
 .. shortname:: DB2
 
+.. build_dependencies:: ODBC library
+
 This driver implements support for access to spatial tables in the IBM
 DB2 for Linux, Unix and Windows (DB2 LUW) and the IBM DB2 for z/OS
 relational databases using the default ODBC support incorporated into

diff --git a/gdal/doc/source/drivers/vector/dgn.rst b/gdal/doc/source/drivers/vector/dgn.rst
@@ -5,6 +5,8 @@ Microstation DGN
 
 .. shortname:: DGN
 
+.. built_in_by_default::
+
 Microstation DGN files from Microstation versions predating version 8.0
 are supported for reading (a :ref:`DGNv8 driver <vector.dgnv8>`, using
 Teigha libraries, is available to read and write DGN v8 files). The

diff --git a/gdal/doc/source/drivers/vector/dgnv8.rst b/gdal/doc/source/drivers/vector/dgnv8.rst
@@ -7,6 +7,8 @@ Microstation DGN v8
 
 .. shortname:: DGNv8
 
+.. build_dependencies:: Open Design Alliance Teigha library
+
 Microstation DGN files from Microstation version 8.0 are supported for
 reading and writing. Each model of the file is represented by a OGR
 layer.

diff --git a/gdal/doc/source/drivers/vector/dods.rst b/gdal/doc/source/drivers/vector/dods.rst
@@ -5,6 +5,8 @@ DODS/OPeNDAP
 
 .. shortname:: DODS
 
+.. build_dependencies:: libdap
+
 This driver implements read-only support for reading feature data from
 OPeNDAP (DODS) servers. It is optionally included in OGR if built with
 OPeNDAP support libraries.

diff --git a/gdal/doc/source/drivers/vector/dwg.rst b/gdal/doc/source/drivers/vector/dwg.rst
@@ -5,6 +5,8 @@ AutoCAD DWG
 
 .. shortname:: DWG
 
+.. build_dependencies:: Open Design Alliance Teigha library
+
 OGR supports reading most versions of AutoCAD DWG when built with the
 Open Design Alliance Teiga library. DWG is an binary working format used
 for AutoCAD drawings. A reasonable effort has been made to make the OGR

diff --git a/gdal/doc/source/drivers/vector/dxf.rst b/gdal/doc/source/drivers/vector/dxf.rst
@@ -5,6 +5,8 @@ AutoCAD DXF
 
 .. shortname:: DXF
 
+.. built_in_by_default::
+
 DXF is an ASCII format used for interchanging AutoCAD drawings between
 different software packages. OGR supports reading DXF files generated by
 all recent versions of AutoCAD, and writing DXF files that are

diff --git a/gdal/doc/source/drivers/vector/edigeo.rst b/gdal/doc/source/drivers/vector/edigeo.rst
@@ -5,6 +5,8 @@ EDIGEO
 
 .. shortname:: EDIGEO
 
+.. built_in_by_default::
+
 This driver reads files encoded in the French EDIGEO exchange format, a
 text based file format aimed at exchanging geographical information
 between GIS, with powerful description capabilities, topology modeling,

diff --git a/gdal/doc/source/drivers/vector/eeda.rst b/gdal/doc/source/drivers/vector/eeda.rst
@@ -7,6 +7,8 @@ Google Earth Engine Data API
 
 .. shortname:: EEDA
 
+.. build_dependencies:: libcurl
+
 The driver supports read-only operations to list images and their
 metadata as a vector layer, using Google Earth Engine REST API.
 

diff --git a/gdal/doc/source/drivers/vector/elasticsearch.rst b/gdal/doc/source/drivers/vector/elasticsearch.rst
@@ -5,6 +5,8 @@ ElasticSearch: Geographically Encoded Objects for ElasticSearch
 
 .. shortname:: ElasticSearch
 
+.. build_dependencies:: libcurl
+
 | Driver is read-write starting with GDAL 2.1 (was write only in GDAL
   2.0 or earlier)
 | As of GDAL 2.1, ElasticSearch 1.X and, partially, 2.X versions are

diff --git a/gdal/doc/source/drivers/vector/esrijson.rst b/gdal/doc/source/drivers/vector/esrijson.rst
@@ -5,6 +5,8 @@ ESRIJSON / FeatureService driver
 
 .. shortname:: ESRIJSON
 
+.. built_in_by_default::
+
 (Note: prior to GDAL 2.3, the functionality of this driver was available
 in the GeoJSON driver. They are now distinct drivers)
 

diff --git a/gdal/doc/source/drivers/vector/filegdb.rst b/gdal/doc/source/drivers/vector/filegdb.rst
@@ -5,6 +5,8 @@ ESRI File Geodatabase (FileGDB)
 
 .. shortname:: FileGDB
 
+.. build_dependencies:: FileGDB API library
+
 The FileGDB driver provides read and write access to vector layers of
 File Geodatabases (.gdb directories) created by ArcGIS 10 and above. The
 dataset name must be the directory/folder name, and it must end with the

diff --git a/gdal/doc/source/drivers/vector/flatgeobuf.rst b/gdal/doc/source/drivers/vector/flatgeobuf.rst
@@ -7,6 +7,8 @@ FlatGeobuf
 
 .. shortname:: FlatGeobuf
 
+.. built_in_by_default::
+
 This driver implements read/write support for access to features encoded
 in `FlatGeobuf <https://github.com/bjornharrtell/flatgeobuf>`__ format, a
 performant binary encoding for geographic data based on flatbuffers that

diff --git a/gdal/doc/source/drivers/vector/fme.rst b/gdal/doc/source/drivers/vector/fme.rst
@@ -5,6 +5,8 @@ FMEObjects Gateway
 
 .. shortname:: FME
 
+.. build_dependencies:: FME
+
 Feature sources supported by FMEObjects are supported for reading by OGR
 if the FMEObjects gateway is configured, and if a licensed copy of
 FMEObjects is installed and accessible.

diff --git a/gdal/doc/source/drivers/vector/geoconcept.rst b/gdal/doc/source/drivers/vector/geoconcept.rst
@@ -5,6 +5,8 @@ GeoConcept text export
 
 .. shortname:: Geoconcept
 
+.. built_in_by_default::
+
 GeoConcept text export files should be available for writing and
 reading.
 

diff --git a/gdal/doc/source/drivers/vector/geojson.rst b/gdal/doc/source/drivers/vector/geojson.rst
@@ -5,6 +5,8 @@ GeoJSON
 
 .. shortname:: GeoJSON
 
+.. built_in_by_default::
+
 This driver implements read/write support for access to features encoded
 in `GeoJSON <http://geojson.org/>`__ format. GeoJSON is a dialect based
 on the `JavaScript Object Notation (JSON) <http://json.org/>`__. JSON is

diff --git a/gdal/doc/source/drivers/vector/geojsonseq.rst b/gdal/doc/source/drivers/vector/geojsonseq.rst
@@ -7,6 +7,8 @@ GeoJSONSeq: sequence of GeoJSON features
 
 .. shortname:: GeoJSONSeq
 
+.. built_in_by_default::
+
 This driver implements read/creation support for features encoded
 individually as `GeoJSON <http://geojson.org/>`__ Feature objects,
 separated by newline (LF) (`Newline Delimited

diff --git a/gdal/doc/source/drivers/vector/geomedia.rst b/gdal/doc/source/drivers/vector/geomedia.rst
@@ -5,6 +5,8 @@ Geomedia MDB database
 
 .. shortname:: Geomedia
 
+.. build_dependencies:: ODBC library
+
 OGR optionally supports reading Geomedia .mdb files via ODBC. Geomedia
 is a Microsoft Access database with a set of tables defined by
 Intergraph for holding geodatabase metadata, and with geometry for

diff --git a/gdal/doc/source/drivers/vector/georss.rst b/gdal/doc/source/drivers/vector/georss.rst
@@ -5,6 +5,8 @@ GeoRSS : Geographically Encoded Objects for RSS feeds
 
 .. shortname:: GeoRSS
 
+.. build_dependencies:: (read support needs libexpat)
+
 GeoRSS is a way of encoding location in RSS or Atom feeds.
 
 OGR has support for GeoRSS reading and writing. Read support is only

diff --git a/gdal/doc/source/drivers/vector/gft.rst b/gdal/doc/source/drivers/vector/gft.rst
@@ -5,6 +5,8 @@ GFT - Google Fusion Tables
 
 .. shortname:: GFT
 
+.. build_dependencies:: libcurl
+
 This driver can connect to the Google Fusion Tables service. GDAL/OGR
 must be built with Curl support in order to the GFT driver to be
 compiled.

diff --git a/gdal/doc/source/drivers/vector/gml.rst b/gdal/doc/source/drivers/vector/gml.rst
@@ -5,6 +5,8 @@ GML - Geography Markup Language
 
 .. shortname:: GML
 
+.. build_dependencies:: (read support needs Xerces or libexpat) 
+
 OGR has limited support for GML reading and writing. Update of existing
 files is not supported.
 

diff --git a/gdal/doc/source/drivers/vector/gmlas.rst b/gdal/doc/source/drivers/vector/gmlas.rst
@@ -7,6 +7,8 @@ GMLAS - Geography Markup Language (GML) driven by application schemas
 
 .. shortname:: GMLAS
 
+.. build_dependencies:: Xerces
+
 This driver can read and write XML files of arbitrary structure,
 included those containing so called Complex Features, provided that they
 are accompanied by one or several XML schemas that describe the

diff --git a/gdal/doc/source/drivers/vector/gmt.rst b/gdal/doc/source/drivers/vector/gmt.rst
@@ -5,6 +5,8 @@ GMT ASCII Vectors (.gmt)
 
 .. shortname:: GMT
 
+.. built_in_by_default::
+
 OGR supports reading and writing GMT ASCII vector format. This is the
 format used by the Generic Mapping Tools (GMT) package, and includes
 recent additions to the format to handle more geometry types, and

diff --git a/gdal/doc/source/drivers/vector/gpkg.rst b/gdal/doc/source/drivers/vector/gpkg.rst
@@ -5,6 +5,8 @@ GPKG -- GeoPackage vector
 
 .. shortname:: GPKG
 
+.. build_dependencies:: libsqlite3
+
 This driver implements support for access to spatial tables in the `OGC
 GeoPackage format
 standard <http://www.opengeospatial.org/standards/geopackage>`__ The

diff --git a/gdal/doc/source/drivers/vector/gpsbabel.rst b/gdal/doc/source/drivers/vector/gpsbabel.rst
@@ -5,6 +5,8 @@ GPSBabel
 
 .. shortname:: GPSBabel
 
+.. build_dependencies:: (read support needs GPX driver and libexpat) 
+
 The GPSBabel driver for now that relies on the
 `GPSBabel <http://www.gpsbabel.org>`__ utility to access various GPS
 file formats.

diff --git a/gdal/doc/source/drivers/vector/gpx.rst b/gdal/doc/source/drivers/vector/gpx.rst
@@ -5,6 +5,8 @@ GPX - GPS Exchange Format
 
 .. shortname:: GPX
 
+.. build_dependencies:: (read support needs libexpat) 
+
 GPX (the GPS Exchange Format) is a light-weight XML data format for the
 interchange of GPS data (waypoints, routes, and tracks) between
 applications and Web services on the Internet.

diff --git a/gdal/doc/source/drivers/vector/grass.rst b/gdal/doc/source/drivers/vector/grass.rst
@@ -5,6 +5,8 @@ GRASS Vector Format
 
 .. shortname:: GRASS
 
+.. build_dependencies:: libgrass
+
 GRASS driver can read GRASS (version 6.0 and higher) vector maps. Each
 GRASS vector map is represented as one datasource. A GRASS vector map
 may have 0, 1 or more layers.