Skip to content

docs: use the jcifs 3.x property names in the JVM options defaults - #532

Merged
marevol merged 1 commit into
mainfrom
fix/jcifs-property-names-in-jvm-options
Sep 10, 2026
Merged

docs: use the jcifs 3.x property names in the JVM options defaults#532
marevol merged 1 commit into
mainfrom
fix/jcifs-property-names-in-jvm-options

Conversation

@marevol

@marevol marevol commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Documentation half of codelibs/fess#3433, itself a follow-up to codelibs/jcifs#81.

config/properties.rst documents the shipped defaults of jvm.crawler.options and
jvm.thumbnail.options, which included seven jcifs system properties:

-Djcifs.smb.client.responseTimeout=30000
-Djcifs.smb.client.soTimeout=35000
-Djcifs.smb.client.connTimeout=60000
-Djcifs.smb.client.sessionTimeout=60000
-Djcifs.smb1.smb.client.connTimeout=60000
-Djcifs.smb1.smb.client.soTimeout=35000
-Djcifs.smb1.smb.client.responseTimeout=30000

None of them are read by the jcifs version Fess ships. 3.0.0 dropped the .smb
segment from every configuration key and folded the legacy SMB1 stack onto the same
keys, so both spellings are ignored without error. Anyone copying these lines out of
the documentation to tune SMB crawl timeouts got no effect and no diagnostic.

This brings the documented defaults in line with codelibs/fess#3433: the four
properties are renamed to jcifs.client.*, and the three jcifs.smb1.smb.client.*
lines are dropped rather than renamed, because since 3.0.0 the legacy stack reads the
same jcifs.client.* keys and keeping them would just duplicate the flags.

Scope

Only en/15.9 documents these JVM options — grep over the development tree finds
jvm.crawler.options in the English config/properties.rst alone. The other six
language trees mention jcifs only in a prose aside in config/crawler-advanced.rst
("approximately 40 options covering jcifs SMB timeouts, ..."), which names no
properties. The real count goes 39 to 36, still within "approximately 40", so those
lines are left alone.

Per the project convention this touches the development tree (versions.json
development = 15.9) only; released trees are not backported.

The documented defaults for jvm.crawler.options and jvm.thumbnail.options
listed seven jcifs system properties under names no supported jcifs
version reads. jcifs 3.0.0 dropped the .smb segment from every key and
folded the legacy SMB1 stack onto the same keys, so both
jcifs.smb.client.* and jcifs.smb1.smb.client.* are ignored.

Match the corrected defaults in codelibs/fess#3433: four properties under
jcifs.client.*, and the three jcifs.smb1.smb.client.* duplicates removed
because the legacy stack now reads the same keys.

Only en/15.9 documents these options; no other language tree in the
development version lists them.
@marevol marevol self-assigned this Sep 10, 2026
@marevol
marevol merged commit 5bdce16 into main Sep 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant