Skip to content

Commit 2b2d500

Browse files
committed
Fix changelog typo and document breaking changes
Remove inaccurate 15% performance improvement claim that was contradicted by benchmark testing. Add missing BREAKING CHANGE label for network options API changes.
1 parent f56a80f commit 2b2d500

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@
77
`Unmarshaler` interface by implementing `UnmarshalMaxMindDB(d *Decoder) error`
88
instead.
99
- `Open` and `FromBytes` now accept options.
10-
- `IncludeNetworksWithoutData` and `IncludeAliasedNetworks` now return a
11-
`NetworksOption` rather than being one themselves. This was done to improve
12-
the documentation organization.
10+
- **BREAKING CHANGE**: `IncludeNetworksWithoutData` and `IncludeAliasedNetworks`
11+
now return a `NetworksOption` rather than being one themselves. These must now
12+
be called as functions: `Networks(IncludeAliasedNetworks())` instead of
13+
`Networks(IncludeAliasedNetworks)`. This was done to improve the documentation
14+
organization.
1315
- Added `Unmarshaler` interface to allow custom decoding implementations for
1416
performance-critical applications. Types implementing
1517
`UnmarshalMaxMindDB(d *Decoder) error` will automatically use custom decoding
@@ -32,17 +34,16 @@
3234
/city/names/en" or "at offset 1234, path /list/0/name" instead of just the
3335
underlying error message.
3436
- **PERFORMANCE**: Added string interning optimization that reduces allocations
35-
while maintaining thread safety. Provides ~15% improvement for single-threaded
36-
City lookups and reduces allocation count from 33 to 10 per operation in
37-
downstream libraries. Uses a fixed 512-entry cache with per-entry mutexes
38-
for bounded memory usage (~8KB) while minimizing lock contention.
37+
while maintaining thread safety. Reduces allocation count from 33 to 10 per
38+
operation in downstream libraries. Uses a fixed 512-entry cache with per-entry
39+
mutexes for bounded memory usage (~8KB) while minimizing lock contention.
3940

4041
## 2.0.0-beta.3 - 2025-02-16
4142

4243
- `Open` will now fall back to loading the database in memory if the
4344
file-system does not support `mmap`. Pull request by database64128. GitHub
4445
#163.
45-
- Made significant improvements to the Windows memory-map handling. . GitHub
46+
- Made significant improvements to the Windows memory-map handling. GitHub
4647
#162.
4748
- Fix an integer overflow on large databases when using a 32-bit architecture.
4849
See ipinfo/mmdbctl#33.

0 commit comments

Comments
 (0)