[SCM] PostGIS branch master updated. 3.6.0rc2-714-g3d021d32b

git at osgeo.org git at osgeo.org
Wed Jul 1 22:08:42 PDT 2026


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "PostGIS".

The branch, master has been updated
       via  3d021d32b46336463576654c4817d6e1f58721a8 (commit)
      from  1a6911201c37ad9dfcdaeddf0d21b90da20a72e9 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 3d021d32b46336463576654c4817d6e1f58721a8
Author: Sandro Santilli <strk at kbt.io>
Date:   Thu Jul 2 07:08:22 2026 +0200

    Move Makefile target documentation from README to `make help`

diff --git a/doc/Makefile.in b/doc/Makefile.in
index b7f684108..a24f92c9f 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -159,7 +159,7 @@ endif
 
 # TODO: add "html" to the BUILD_TARGET if it can be built
 
-all: $(BUILD_TARGET)
+all: $(BUILD_TARGET) ## Build all buildable documentation
 
 XML_SOURCES = \
 	administration.xml \
@@ -351,7 +351,7 @@ $(XML_UNIFIED_POT): $(XML_SOURCE_POTS)
   fi;
 
 # Creates or updates translation files
-update-po: $(PO_FILES)
+update-po: $(PO_FILES) ## Update translation files to be in sync with the source XML files (see check-localized)
 
 $(PO_FILES): $(XML_UNIFIED_POT)
 	@mkdir -p `dirname $@`
@@ -403,6 +403,8 @@ postgis-out.xml: postgis.xml Makefile $(XML_INPUTS) Makefile
 	$(PERL) -lpe "s'@@LAST_RELEASE_VERSION@@'${POSTGIS_MAJOR_VERSION}.${POSTGIS_MINOR_VERSION}.${POSTGIS_MICRO_VERSION}'g;s'@@POSTGIS_DOWNLOAD_URL@@'${POSTGIS_DOWNLOAD_URL}'g;" $< > $@.in
 	$(XMLLINT) $(XSLTPROC_PATH_OPT) --noent -o $@ $@.in
 
+chunked-html: ## Generate multi-file html in html/postgis-en/
+
 chunked-html: $(html_builddir)/postgis$(DOCSUFFIX)/index.html
 $(html_builddir)/postgis$(DOCSUFFIX)/index.html: postgis-out.xml Makefile
 	$(XSLTPROC) $(XSLTPROC_COMMONOPTS) \
@@ -412,7 +414,11 @@ $(html_builddir)/postgis$(DOCSUFFIX)/index.html: postgis-out.xml Makefile
 		$(CHUNK_HTML_DOCBOOK_XSL) \
 		$<
 
-html: $(html_builddir)/postgis$(DOCSUFFIX).html
+html: $(html_builddir)/postgis$(DOCSUFFIX).html ## Generate a single-file html/postgis-en.html
+
+html-localized: ## Generate a single-file html/postgis-<lang>.html for supported languages
+pdf-localized: ## Generate a postgis-<version>-<lang>.pdf for supported languages
+check-localized: ## Check structural correctness of localized (translated) XML documentation.
 
 %-localized:
 	rule=$(patsubst %-localized,%,$@); \
@@ -483,14 +489,16 @@ epub-uninstall:
 
 epub: postgis-${POSTGIS_MAJOR_VERSION}.${POSTGIS_MINOR_VERSION}.${POSTGIS_MICRO_VERSION}$(DOCSUFFIX).epub
 
-pdf: postgis-${POSTGIS_MAJOR_VERSION}.${POSTGIS_MINOR_VERSION}.${POSTGIS_MICRO_VERSION}$(DOCSUFFIX).pdf
+pdf: postgis-${POSTGIS_MAJOR_VERSION}.${POSTGIS_MINOR_VERSION}.${POSTGIS_MICRO_VERSION}$(DOCSUFFIX).pdf ## Generate postgis-<version>-en.pdf
 
 doxygen.cfg: doxygen.cfg.in
 	$(PERL) -lpe "s'@@LAST_RELEASE_VERSION@@'${POSTGIS_MAJOR_VERSION}.${POSTGIS_MINOR_VERSION}.${POSTGIS_MICRO_VERSION}'g" $< > $@
 
-doxygen: doxygen.cfg
+doxygen: doxygen.cfg ## Generate developer's documentation using Doxygen
 	doxygen $<
 
+images: ## Generate images used in html and pdf targets
+
 images images-install images-uninstall images-clean:
 	$(MAKE) -C $(images_builddir) $@
 
@@ -515,7 +523,7 @@ cheatsheet-install: $(GENERATED_CHEATSHEET_FILES)
 cheatsheet-clean:
 	rm -f $(GENERATED_CHEATSHEET_FILES)
 
-clean: images-clean html-clean pdf-clean epub-clean cheatsheet-clean clean-pot
+clean: images-clean html-clean pdf-clean epub-clean cheatsheet-clean clean-pot ## Remove generated files except comments
 	rm -f images # work around https://trac.osgeo.org/postgis/ticket/5422
 	rm -f $(XML_GENERATED_SOURCES)
 	rm -f postgis-nospecial.xml postgis-nospecial.xml.in
@@ -537,9 +545,11 @@ distclean: clean
 	$(MAKE) distclean-localized
 	rm -f Makefile Makefile.comments
 
-maintainer-clean: distclean
+maintainer-clean: distclean ## Remove all generated files (including comments)
 	rm -f $(GENERATED_COMMENT_FILES)
 
+comments: ## Generate SQL scripts that add COMMENTs for every function (derived from the documentation)
+
 ifneq ($(CAN_BUILD_COMMENTS),yes)
 comments:
 else
@@ -548,6 +558,8 @@ endif
 
 cheatsheets: $(GENERATED_CHEATSHEET_FILES)
 
+comments-install: ## Install the SQL comment scripts to the PostgreSQL contrib directory
+
 ifneq ($(CAN_BUILD_COMMENTS),yes)
 comments-install:
 	if test -e postgis_comments.sql  -a \
@@ -561,7 +573,7 @@ comments-install: comments
 	$(MAKE) -f Makefile.comments install
 endif
 
-comments-uninstall:
+comments-uninstall: ## Removes the SQL comment scripts from the PostgreSQL contrib directory
 	$(MAKE) -f Makefile.comments uninstall
 
 man-install: man/shp2pgsql.1 man/pgsql2shp.1 man/raster2pgsql.1 man/pgtopo_export.1 man/pgtopo_import.1 man/postgis.1 man/postgis_restore.1
@@ -606,9 +618,9 @@ docs-install: html-install html-assets-install
 docs-uninstall: html-uninstall html-assets-uninstall
 	rm -f $(DESTDIR)$(PGSQL_DOCDIR)/postgis/README.postgis
 
-install: comments-install man-install
+install: comments-install man-install ## Install sql comments and man pages
 
-uninstall: comments-uninstall man-uninstall
+uninstall: comments-uninstall man-uninstall ## Uninstall sql comments and man pages
 
 ifeq ($(XSLTPROC),)
 garden: requirements_not_met_xsltproc
@@ -619,7 +631,7 @@ endif
 %_gardentest_${POSTGIS_MAJOR_VERSION}${POSTGIS_MINOR_VERSION}.sql: xsl/%_gardentest.sql.xsl postgis-out.xml
 	$(XSLTPROC) -o $@ $(XSLTPROC_PATH_OPT) $^
 
-check: check-unit
+check: check-unit ## Check structural correctness of XML documentation with DocBook DTD, RelaxNG, and XMLSchema validation
 check-regress:
 
 check-unit: $(CHECK_UNIT_TARGET)
@@ -703,3 +715,6 @@ requirements_not_met_xml2pot:
 	@echo "configure was unable to find the 'xml2pot' utility program."
 	@echo "To update the translation templates, install poxml and then re-run configure."
 	@echo
+
+help: ## Print this help message
+	@grep -E '^[a-zA-Z._-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
diff --git a/doc/README b/doc/README
index 865190eb3..6e99f44fc 100644
--- a/doc/README
+++ b/doc/README
@@ -8,74 +8,13 @@ PostGIS documentation is written in DocBook XML. The input file is
 ``postgis.xml``, which in turn includes all the individual chapter XML files.
 From that file we can publish several formats, including HTML and PDF.
 
+The documentation can be translated to multiple languages, see po/README for
+instructions about how to do that.
+
 Make targets
 ------------
 
-``make``
-  same as ``make comments``
-
-``make install``
-  same as ``make comments-install``
-
-``make uninstall``
-  same as ``make comments-uninstall``
-
-``make html``
-  generates a single-file ``html/postgis.html``
-
-``make html-localized``
-  generates single-file ``html/postgis-<lang>.html`` for
-  each supported language
-
-``make chunked-html``
-  generates a separate html file for every chapter or section break
-  You can use CHUNKED_HTML_USER_OPTS environment variable to tweak
-  the output, for example:
-  > make chunked-html XSLTPROCFLAGS="--stringparam html.script custom.js
-
-``make pdf``
-  generates a single PDF file with the PostGIS version as a filename
-
-``make pdf-localized``
-  generates a single PDF file with the PostGIS version as a filename
-  and ``-<lang>`` suffix for each supported language
-
-``make images``
-  generates all the images used in the HTML and PDF targets
-
-``make comments``
-  generates an SQL script that add COMMENTs for every function (derived from
-  the documentation)
-
-``make doxygen``
-  generates the developer's documentation using Doxygen
-
-``make comments-install``
-  copies the ``postgis-comments.sql`` script to the PostgreSQL ``contrib``
-  directory
-
-``make comments-uninstall``
-  removes the ``postgis-comments.sql`` script from the ``contrib`` directory
-
-``make clean``
-  removes generated files except comments
-
-``make maintainer-clean``
-  removes all generated files (including comments)
-
-``make update-po``
-  update translation files to be in sync with the source
-  XML files. See ``make check-localized``
-
-``make check``
-  check structural correctness of XML documentation with DocBook DTD,
-  RelaxNG, and XMLSchema validation
-
-``make check-localized``
-  check structural correctness of localized (translated)
-  XML documentation. Remember to run this before committing
-  updates to translation files (see ``make update-po``)
-
+Run `make help` to get help on notable targets.
 
 Requirements
 ------------
diff --git a/doc/po/README b/doc/po/README
index b38e3203a..447de9efb 100644
--- a/doc/po/README
+++ b/doc/po/README
@@ -7,9 +7,9 @@ In language subdirectories, run ``make`` to build localized manual and
 comments, ``make local-pdf`` for the pdf.
 
 In parent directory (doc), run ``make update-po`` to update the translation
-files to be in sync with the source code, ``make html-localized`` or
-``make pdf-localized`` to build the localized html or pdf manual for
-all enabled languages
+files to be in sync with the source code, ``make check-localized`` to verify
+structural correctness, ``make html-localized`` or ``make pdf-localized``
+to build the localized html or pdf manual for all enabled languages
 
 Adding languages
 ----------------
@@ -28,7 +28,7 @@ Adding new languages implies (relative to doc/ dir):
   - Running `make update-po`
 
   - Check the new language works:
-    make -C po/<newlanguage>
+    make -C po/<newlanguage> local-check html pdf
 
   - Add to the git repository the changes in the Makefile.in
     and all the new files in the po/<newlanguage>/

-----------------------------------------------------------------------

Summary of changes:
 doc/Makefile.in | 37 ++++++++++++++++++++++---------
 doc/README      | 69 ++++-----------------------------------------------------
 doc/po/README   |  8 +++----
 3 files changed, 34 insertions(+), 80 deletions(-)


hooks/post-receive
-- 
PostGIS


More information about the postgis-tickets mailing list