Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Improve documentation of configuration settings

Description

Improve documentation of configuration settings as a User Guide appendix.

Much of this has been done under HHH-17047 and HHH-16962. This is a task to finish up that work and decide on the visual design of the sections.

Details available:

  1. Name of the setting

  2. FQN of the "setting field"

  3. Javadoc text from the field in Asciidoc format

  4. Deprecation status

  5. Incubation status

  6. @since

  7. @settingDefault (new, custom tag)

This also includes consolidating the information between the older hand-maintained appendix (26. Configurations) and this new generated appendix (35. Configuration settings), which mainly means making sure useful information from (26. Configurations) is incorporated into the Javadoc

relates to

Activity

Show:

Jon HarperNovember 9, 2023 at 10:04 AM

hi , do you have more information about this removal ?

Also, do you plan to add a typesafe key in https://docs.jboss.org/hibernate/orm/6.2/javadocs/org/hibernate/cfg/AvailableSettings.html ?

Jon HarperOctober 9, 2023 at 10:00 AM

hi, this leads to the removal of the documentation for "hibernate.temp.use_jdbc_metadata_defaults" https://docs.jboss.org/hibernate/orm/6.1/userguide/html_single/Hibernate_User_Guide.html#configurations-internal has it but 6.2 and 6.3 no longer have it.

it's used by other projects for example https://github.com/liquibase/liquibase-hibernate/blob/38aa95cba6595378fd6c0f1111a97fbebf66a92e/src/main/java/liquibase/ext/hibernate/database/HibernateClassicDatabase.java#L48

Could you maybe clarify the status of this configuration ? Should it be added to the generated docs from AvailableSettings.java or something ?

Thanks,
Jon

Fixed

Details

Assignee

Reporter

Sprint

Fix versions

Priority

Created August 15, 2023 at 1:07 PM
Updated November 9, 2023 at 10:04 AM
Resolved August 28, 2023 at 3:30 PM

Flag notifications