[eXist-commits] [eXist-db/exist] ebc653: [bugfix] Deprecate xqdm:scan and the xqdoc extensi...

[Duncan P. <no...@gi...>]

  Branch: refs/heads/develop
  Home:   https://github.com/eXist-db/exist
  Commit: ebc65325309382a03beef450a9eb671934ac852c
      https://github.com/eXist-db/exist/commit/ebc65325309382a03beef450a9eb671934ac852c
  Author: Joe Wicentowski <jo...@gm...>
  Date:   2026-09-19 (Sat, 19 Sep 2026)

  Changed paths:
    M extensions/xqdoc/src/main/java/org/exist/xqdoc/xquery/Scan.java
    M extensions/xqdoc/src/main/java/org/exist/xqdoc/xquery/XQDocModule.java
    A extensions/xqdoc/src/test/java/org/exist/xqdoc/XQDocDeprecationTest.java

  Log Message:
  -----------
  [bugfix] Deprecate xqdm:scan and the xqdoc extension module for removal

Agreed for 7.0.0 in https://github.com/eXist-db/exist/issues/6717 (+1 from @duncdrum,
+1 "for deprecation for removal" from @line-o).

extensions/xqdoc is built on the external org.xqdoc:xqdoc-conversion library, whose only
release on Maven Central is 1.6, published 2012-08-17 -- before XQuery 3.0 was a
recommendation. There is nothing newer to upgrade to.

Measured on develop, it does not work. Each of these minimal modules fails inside
Scan.java with "error while scanning module":

  map(*) in a signature      unexpected token: (
  %private annotation        unexpected char: '%'
  map { "k": 1 }             unexpected token: {
  [ 1, 2 ]                   unexpected token: [
  (1,2) ! (. + 1)            unexpected char: '!'

It also fails eXist's own bundled libraries: both queries in the module's own test suite,
scanning kwic.xql by module URI and from the classpath, return "unexpected token:
version". That is presumably why all four tests in
extensions/xqdoc/src/test/xquery/xqdoc/tests.xml carry ignore="true" -- the module's suite
reports BUILD SUCCESS while verifying nothing.

Nor is anything calling it: a GitHub code search across the eXist-db and existdb accounts
returns one hit for xqdoc:scan, extensions/xqdoc/ant-example.xml in this repository.

Both xqdm:scan signatures and the module description now carry a deprecation notice
naming inspect:inspect-module as the replacement. That is eXist's own implementation,
built on the XQDocParser.g grammar in exist-core, and is unaffected by any of the above --
deprecating this module does not remove xqdoc-style introspection from eXist.

Deprecation, not removal: the function stays callable. The notice reaches users through
util:describe-function, through inspect:inspect-module, and through the module
description, and an administrator who sets the existing
PROPERTY_DISABLE_DEPRECATED_FUNCTIONS turns a call into XPST0017. Removal is a separate,
later step.

XQDocDeprecationTest pins all four of those surfaces, including that the function remains
available. It is, as far as I can tell, the first test in this module that actually runs.

Co-Authored-By: Claude Opus 5 <no...@an...>


  Commit: 74ad7da9fbab8ccfceef3b66ec95b2f624abe6fa
      https://github.com/eXist-db/exist/commit/74ad7da9fbab8ccfceef3b66ec95b2f624abe6fa
  Author: Duncan Paterson <dun...@us...>
  Date:   2026-09-21 (Mon, 21 Sep 2026)

  Changed paths:
    M extensions/xqdoc/src/main/java/org/exist/xqdoc/xquery/Scan.java
    M extensions/xqdoc/src/main/java/org/exist/xqdoc/xquery/XQDocModule.java
    A extensions/xqdoc/src/test/java/org/exist/xqdoc/XQDocDeprecationTest.java

  Log Message:
  -----------
  Merge pull request #6728 from joewiz/deprecate/xqdoc-scan-7.0


Compare: https://github.com/eXist-db/exist/compare/5192d11f21c0...74ad7da9fbab

To unsubscribe from these emails, change your notification settings at https://github.com/eXist-db/exist/settings/notifications