Skip to content

Commit

Permalink
Misc copy editing
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrotteveel
mrotteveel committed Dec 27, 2024
1 parent 65f204f commit dd85dd9
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 34 deletions.
2 changes: 1 addition & 1 deletion devdoc/publish.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Publishing
To publish to Maven use

```
gradlew clean assemble publish -PcredentialsPassphrase=<credentials password>
gradlew clean dist assemble publish -PcredentialsPassphrase=<credentials password>
```
Where `<credentials password>` is the password used to add the credentials (see
also below).
Expand Down
48 changes: 20 additions & 28 deletions src/docs/asciidoc/faq.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
:source-highlighter: prettify
:toc: left
:icons: font
:jaybird6-full-version: 6.0.0-beta-1
:jaybird6-full-version: 6.0.0
:jaybird6-jna-version: 5.16.0
:jaybird5-full-version: 5.0.6
:jaybird5-template-version: {jaybird5-full-version}.<java>
Expand Down Expand Up @@ -35,14 +35,6 @@
[#jaybird-6]
==== Jaybird 6

[CAUTION]
====
Jaybird 6 is not yet released.
The provided Maven dependency is not for production use, and for testing and evaluation purposes only.
If you're looking for the latest released Jaybird, use <<jaybird-5>>
====

Jaybird 6 is available on Maven Central:

[horizontal.compact]
Expand All @@ -67,7 +59,7 @@ If you want to use Type 2 support (native or embedded), you need to add `jaybird
----
<dependency>
<groupId>org.firebirdsql.jdbc</groupId>
<artifactId>jaybird</artifactId>
<artifactId>jaybird-native</artifactId>
<version>{jaybird6-full-version}</version>
</dependency>
----
Expand Down Expand Up @@ -332,21 +324,21 @@ Future versions of Jaybird may specify an explicit version, or be released under
[discrete]
=== Jaybird 6
Jaybird 6 supports Java 17, 21, and 23.
Jaybird 6 supports Java 17, Java 21, and Java 23.
Support for Java 17 and higher is limited to Java 17, Java 21, -- once available -- the latest LTS after Java 21, and the latest Java release.
[#java-jaybird-5]
[discrete]
=== Jaybird 5
Jaybird 5 supports Java 8, 11, 17, 21, and 23.
Support for Java 9 and higher is limited to Java 8, 11, 17, 21, -- once available -- the latest LTS version after Java 21, and the latest Java release.
Jaybird 5 supports Java 8, Java 11, Java 17, Java 21, and Java 23.
Support for Java 9 and higher is limited to Java 8, Java 11, Java 17, Java 21, -- once available -- the latest LTS version after Java 21, and the latest Java release.
Jaybird 5 is the last version to support Java 8 and 11, support has been dropped with Jaybird 6, raising the minimum supported version to Java 17.
Jaybird 5 is the last version to support Java 8 and Java 11, support has been dropped with Jaybird 6, raising the minimum supported version to Java 17.
[NOTE]
====
Jaybird 5 will serve as a form of long-term support for Java 8 and 11, with maintenance releases guaranteed at least until the release of Jaybird 7.
Jaybird 5 will serve as a form of long-term support for Java 8 and Java 11, with maintenance releases guaranteed at least until the release of Jaybird 7.
See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2022-03-java-17-minimum-version.md[jdp-2022-03: Java 17 minimum version].
====
Expand All @@ -355,8 +347,8 @@ See also https://github.com/FirebirdSQL/jaybird/blob/master/devdoc/jdp/jdp-2022-
[discrete]
=== Jaybird 4
Jaybird 4 supports Java 7, 8, 11, 17 and 21.
Support for Java 9 and higher is limited to Java 11, 17 and 21.
Jaybird 4 supports Java 7, Java 8, Java 11, Java 17 and Java 21.
Support for Java 9 and higher is limited to Java 11, Java 17 and Java 21.
Jaybird 4 is the last version to support Java 7, support was dropped with Jaybird 5.
Jaybird 4.0.10 is the last release of Jaybird 4, and is end-of-life.
Expand All @@ -366,7 +358,7 @@ We recommend upgrading to Jaybird 5.
[discrete]
=== Jaybird 3
Jaybird 3 supports Java 7 and 8 and has basic support for Java 9 and higher using the Java 8 version of the driver.
Jaybird 3 supports Java 7 and Java 8 and has basic support for Java 9 and higher using the Java 8 version of the driver.
Support for Java 9 and higher is limited to Java 11 and 17, but in practice Jaybird should work on all Java 9+ versions upto Java 17 (versions after Java 17 have not been tested).
Jaybird 3.0.12 is the last release of Jaybird 3, and is end-of-life.
We recommend upgrading to Jaybird 5.
Expand All @@ -375,7 +367,7 @@ We recommend upgrading to Jaybird 5.
[discrete]
=== Jaybird 2.2
Jaybird 2.2 supports Java 6, 7 and 8.
Jaybird 2.2 supports Java 6, Java 7 and Java 8.
Jaybird 2.2.15 is that last release of Jaybird 2.2, and is end-of-life.
We recommend upgrading to Jaybird 5.
Expand Down Expand Up @@ -410,7 +402,7 @@ To ensure a stable module name, Jaybird 5 and older, since versions 2.2.14 and 3
[discrete]
=== Jaybird 6
Jaybird 6 supports Firebird versions 3.0, 4.0, and 5.0.
Jaybird 6 supports Firebird 3.0, Firebird 4.0, and Firebird 5.0.
By default, Jaybird 6 -- using the pure Java protocol -- will not connect to Firebird 2.5 and older.
See <<connection-rejected-by-remote-interface-335544421>> for a workaround.
Expand All @@ -419,7 +411,7 @@ See <<connection-rejected-by-remote-interface-335544421>> for a workaround.
[discrete]
=== Jaybird 5
Jaybird 5 supports Firebird versions 2.5, 3.0, 4.0, and 5.0.
Jaybird 5 supports Firebird 2.5, Firebird 3.0, Firebird 4.0, and Firebird 5.0.
Jaybird 5 is the last version to support Firebird 2.5.
Future versions of Jaybird are not guaranteed to work with Firebird 2.5 and earlier.
Expand All @@ -428,7 +420,7 @@ Future versions of Jaybird are not guaranteed to work with Firebird 2.5 and earl
[discrete]
=== Jaybird 4
Jaybird 4 supports Firebird version 2.5, 3.0 and 4.0, and introduces support for Firebird 4.0 types `DECLOAT`, extended precision of `NUMERIC` and `DECIMAL`, and time zone types (`TIME WITH TIME ZONE` and `TIMESTAMP WITH TIME ZONE`).
Jaybird 4 supports Firebird 2.5, Firebird 3.0 and Firebird 4.0, and introduces support for Firebird 4.0 types `DECLOAT`, extended precision of `NUMERIC` and `DECIMAL`, and time zone types (`TIME WITH TIME ZONE` and `TIMESTAMP WITH TIME ZONE`).
Jaybird 4 only provides partial support for Firebird 5.0, and the generated-keys support does not work in all cases due to Firebird 5.0 now supporting multi-row `RETURNING`.
Full Firebird 5.0 support is available in Jaybird 5.
Expand All @@ -437,23 +429,23 @@ Full Firebird 5.0 support is available in Jaybird 5.
[discrete]
=== Jaybird 3
Jaybird 3 supports Firebird versions 2.0 - 4.0.
Jaybird 3 supports Firebird 2.0, Firebird 2.1, firebird 2.5, Firebird 3.0, and Firebird 4.0.
Support for Firebird 4.0 is limited to the Firebird 3.0 feature set.
Formally, Firebird 5.0 is not supported, though in practice the problems are similar as for Jaybird 4.
Jaybird 3 is the last version to support Firebird 2.0 and 2.1.
Future versions of Jaybird are not guaranteed to work with version 2.1 and earlier.
Jaybird 3 is the last version to support Firebird 2.0 and Firebird 2.1.
Jaybird 4 and higher are not guaranteed to work with Firebird 2.1 and earlier.
[#firebird-jaybird-2-2]
[discrete]
=== Jaybird 2.2
Jaybird 2.2 supports Firebird versions 1.0 - 4.0.
Jaybird 2.2 supports Firebird versions Firebird 1.0, Firebird 1.5, Firebird 2.0, Firebird 2.1, Firebird 2.5, Firebird 3.0, and Firebird 4.0.
Jaybird 2.2.4 added support for new features of Firebird 3.0 (e.g. `BOOLEAN` support).
Support for Firebird 4.0 is limited to the Firebird 3.0 feature set.
Jaybird 2.2 is the last version to support Firebird 1.0 and 1.5.
Future versions of Jaybird are not guaranteed to work with these versions.
Jaybird 2.2 is the last version to support Firebird 1.0 and Firebird 1.5.
Jaybird 3 and higher are not guaranteed to work with these versions.
[#can-jaybird-connect-to-interbase]
== Can Jaybird connect to Interbase?
Expand Down
22 changes: 17 additions & 5 deletions src/docs/asciidoc/release_notes.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
:jaybird-fbclient-version: 5.0.1.1
:firebird-java: https://groups.google.com/g/firebird-java
:issues: https://github.com/FirebirdSQL/jaybird/issues
:jaybird-repo: https://github.com/FirebirdSQL/jaybird
:fb-canonical-html: https://firebirdsql.org/docs/drivers/java/6.0.x/release_notes.html

ifeval::["{version_tag}" != ""]
Expand Down Expand Up @@ -121,6 +122,8 @@ Feedback can be sent to the {firebird-java}[Firebird-java mailing list] or repor
Jaybird {version_wo_target} was tested against Firebird 3.0.12, Firebird 4.0.5, Firebird 5.0.1 and a recent snapshot of Firebird 6.0, but should also support other Firebird versions from 3.0 and up.
Firebird 2.5 and older are not supported.

Firebird 6.0 is currently also not considered supported (see also <<firebird-support>> in <<whats-new-in-jaybird-6>>).

Jaybird 6 will -- by default -- not connect to Firebird 2.5 or older.
See also <<unsupported-protocol>>.

Expand Down Expand Up @@ -316,7 +319,7 @@ At minimum, Jaybird 6 requires `jaybird-{version_example}.jar`.
For native or embedded support, also add `jaybird-native-{version_example}.jar` and `jna-jpms-{jna-version}.jar` on your classpath or modulepath.
See also <<type-2-native-and-embedded-driver>>.

For "`ChaCha64`" wire-encryption support with pure Java connections, also add `chacha64-plugin-{version_example}.jar` and `bcprov-jdk18on-{bc-version}.jar`.
For "`ChaCha64`" wire-encryption support with pure Java connections, also add `chacha64-plugin-{version_example}.jar`, and `bcprov-jdk18on-{bc-version}.jar` from the `lib` directory of the distribution zip.

[#upgrading-from-jaybird-5-to-jaybird-6]
== Upgrading from Jaybird 5 to Jaybird 6
Expand Down Expand Up @@ -391,14 +394,14 @@ If you have an older version of JNA or a `jna-{jna-version}` instead of `jna-jpm
[#gotchas]
=== Gotcha's

If you find a problem while upgrading, or other bugs, please report it on {issues}[^].
If you find a problem while upgrading, or other bugs, please report it on {issues}[^] (see also <<reporting-bugs>>).

For known issues, consult <<known-issues>>.

[#whats-new-in-jaybird-6]
== What's new in Jaybird 6

For a full list of changes, see https://github.com/FirebirdSQL/jaybird/milestone/1?closed=1[Milestone "`v6-initial`"].
For a full list of changes, see milestones https://github.com/FirebirdSQL/jaybird/milestone/1?closed=1["`v6-initial`"] and https://github.com/FirebirdSQL/jaybird/milestone/8?closed=1["`v6.0.0`"].

[#jaybird-version-numbering]
=== Changes in version numbering
Expand Down Expand Up @@ -442,7 +445,16 @@ Given the limited support period for Java 17 and higher versions, not all Java r
Support for Firebird 2.5 has been dropped.
See also <<support-for-firebird-25-dropped>>.

Jaybird 6 supports Firebird 3.0, Firebird 4.0, and Firebird 5.0, and provides tentative support for Firebird 6.0.
Jaybird 6 supports Firebird 3.0, Firebird 4.0, and Firebird 5.0.

.No promises on Firebird 6.0 support
[WARNING]
====
Firebird 6.0 is still in its early stages of development, and is expected to include changes -- like schema support -- that may impact Jaybird.
As a result -- at this time -- we make no promises on the support for Firebird 6.0 by Jaybird 6.
We may delay support for Firebird 6.0 until Jaybird 7, or we may improve support during maintenance releases of Jaybird 6.
====

Jaybird 6 will -- by default -- not connect to unsupported versions (that is, Firebird 2.5 or older) using the pure Java protocol.
See also <<unsupported-protocol>>.
Expand Down Expand Up @@ -675,7 +687,7 @@ When this connection property is enabled, the `DatabaseMetaData` of that connect
* `getCatalogSeparator()` returns `"."` (string with period).
* `getCatalogTerm()` returns `"PACKAGE"`.
* `isCatalogAtStart()` returns `true`.
* `getMaxCatalogNameLength()` returns 31 or 63 depending on the max identifier length of the database.
* `getMaxCatalogNameLength()` returns 31 or 63 depending on the maximum identifier length of the Firebird version.
* `supportsCatalogsInDataManipulation()` returns `true` (i.e. access selectable stored procedures and functions from packages).
* `supportsCatalogsInProcedureCalls()` returns `true`.
* The other `supportsCatalogsIn__type__()` methods continue to return `false`.
Expand Down

0 comments on commit dd85dd9

Please sign in to comment.