From 9a18cb9697d5bf6bdfd19e20e49934b0ce83a12a Mon Sep 17 00:00:00 2001 From: Mike Dalessio Date: Tue, 24 Sep 2024 17:37:06 -0400 Subject: [PATCH] version bump to v2.1.0 also, some additional information in the CHANGELOG and README files. --- CHANGELOG.md | 25 ++++++++----------------- README.md | 2 +- lib/sqlite3/version.rb | 2 +- 3 files changed, 10 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 843d4bea..90ca0ad6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,6 @@ # sqlite3-ruby Changelog -## prerelease 2.1.0.rc3 / 2024-09-18 - -### Improved - -- Allow suppression of fork safety warnings. [#566] @flavorjones - - -## prerelease 2.1.0.rc2 / 2024-09-18 - -### Improved - -- Address a performance regression in 2.1.0.rc1. - - -## prerelease 2.1.0.rc1 / 2024-09-18 +## 2.1.0 / 2024-09-24 ### Ruby @@ -28,9 +14,9 @@ Sqlite itself is [not fork-safe](https://www.sqlite.org/howtocorrupt.html#_carry - All open writable database connections carried across a `fork()` will immediately be closed in the child process to mitigate the risk of corrupting the database file. - These connections will be incompletely closed ("discarded") which will result in a one-time memory leak in the child process. -If it's at all possible, we strongly recommend that you close writable database connections in the parent before forking. +If it's at all possible, we strongly recommend that you close writable database connections in the parent before forking. If absolutely necessary (and you know what you're doing), you may suppress the fork safety warnings by calling `SQLite3::ForkSafety.suppress_warnings!`. -See the README "Fork Safety" section and `adr/2024-09-fork-safety.md` for more information. [#558] @flavorjones +See the README's "Fork Safety" section and `adr/2024-09-fork-safety.md` for more information. [#558, #565, #566] @flavorjones ### Improved @@ -39,6 +25,11 @@ See the README "Fork Safety" section and `adr/2024-09-fork-safety.md` for more i - When setting a Database `busy_handler`, fire the write barrier to prevent potential crashes during the GC mark phase. [#556] @jhawthorn +### Documentation + +- The `FAQ.md` has been updated to fix some inaccuracies. [#562] @rickhull + + ## 2.0.4 / 2024-08-13 ### Dependencies diff --git a/README.md b/README.md index feeb2d2a..b83dcf7e 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ To help protect users of this gem from accidental corruption due to this lack of connections in the child will incur a small one-time memory leak per connection, but that's preferable to potentially corrupting your database. -Whenever possible, close writable connections in the parent before forking. +Whenever possible, close writable connections in the parent before forking. If absolutely necessary (and you know what you're doing), you may suppress the fork safety warnings by calling `SQLite3::ForkSafety.suppress_warnings!`. See [./adr/2024-09-fork-safety.md](./adr/2024-09-fork-safety.md) for more information and context. diff --git a/lib/sqlite3/version.rb b/lib/sqlite3/version.rb index c8119403..21b0c51c 100644 --- a/lib/sqlite3/version.rb +++ b/lib/sqlite3/version.rb @@ -1,3 +1,3 @@ module SQLite3 - VERSION = "2.1.0.rc3" + VERSION = "2.1.0" end