Update repository and crate details

Author: tobiemh

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.24.0-surreal.1 (2026-03-02)
+
+This is the SurrealDB fork of rust-rocksdb, based on upstream version 0.24.0.
+
+### Repository
+
+- Update repository URLs to surrealdb/rust-rocksdb
+- Rename crate to `surrealdb-rocksdb` (lib name remains `rocksdb`)
+- Rename sys crate to `surrealdb-librocksdb-sys`
+
 ## 0.24.0 (2025-08-10)
 
 ### Features

CONTRIBUTING.md

@@ -10,9 +10,9 @@ Thank you for taking an interest in the project, and contributing to it - it's a
 
 ## Bug Reports
 [bug-reports]: #bug-reports
-- **Ensure the bug has not already been reported** - this can be done with a quick search of the [existing open issues](https://github.com/rust-rocksdb/rust-rocksdb/issues?q=is%3Aissue+is%3Aopen+).
+- **Ensure the bug has not already been reported** - this can be done with a quick search of the [existing open issues](https://github.com/surrealdb/rust-rocksdb/issues?q=is%3Aissue+is%3Aopen+).
 - **Ensure the bug applies to the Rust wrapper, and not the underlying library** - bugs in the RocksDB library should be [reported upstream](https://github.com/facebook/rocksdb/issues).
-- When [creating an issue](https://github.com/rust-rocksdb/rust-rocksdb/issues/new) please try to:
+- When [creating an issue](https://github.com/surrealdb/rust-rocksdb/issues/new) please try to:
     - **Use a clear and descriptive title** to identify the issue
     - **Provide enough context** to accurately summarize the issue. Not every issue will need detailed steps to recreate, example code, stack traces, etc. - use your own judgment on what information would be helpful to anyone working on the issue. It's easier for someone to skim over too much context, than stop and wait for a response when context is missing.
 
@@ -30,7 +30,7 @@ Discussion around the design and development of the wrapper primarily occurs wit
 
 ## Pull Requests
 [pull-requests]: #pull-requests
-Pull requests are welcome, and when contributing code, the author agrees to do so under the project's [licensing](https://github.com/rust-rocksdb/rust-rocksdb/blob/master/LICENSE) - Apache 2.0 as of the time of this writing. The maintainers greatly appreciate PRs that follow open-source contribution best practices:
+Pull requests are welcome, and when contributing code, the author agrees to do so under the project's [licensing](https://github.com/surrealdb/rust-rocksdb/blob/master/LICENSE) - Apache 2.0 as of the time of this writing. The maintainers greatly appreciate PRs that follow open-source contribution best practices:
 1. Fork this repository to your personal GitHub account.
 1. Create a branch that includes your changes, **keep changes isolated and granular**.
 1. Include any relevant documentation and/or tests. Write [documentation tests](https://doc.rust-lang.org/rustdoc/documentation-tests.html) when relevant.

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "rocksdb"
+name = "surrealdb-rocksdb"
 description = "Rust wrapper for Facebook's RocksDB embeddable database"
 version = "0.24.0"
 edition = "2021"
@@ -8,16 +8,19 @@ authors = [
     "Tyler Neely <t@jujit.su>",
     "David Greenberg <dsg123456789@gmail.com>",
 ]
-repository = "https://github.com/rust-rocksdb/rust-rocksdb"
+repository = "https://github.com/surrealdb/rust-rocksdb"
 license = "Apache-2.0"
 categories = ["database"]
 keywords = ["database", "embedded", "LSM-tree", "persistence"]
-homepage = "https://github.com/rust-rocksdb/rust-rocksdb"
+homepage = "https://github.com/surrealdb/rust-rocksdb"
 exclude = [".gitignore", ".travis.yml", "deploy.sh", "test/**/*"]
 
 [workspace]
 members = ["librocksdb-sys"]
 
+[lib]
+name = "rocksdb"
+
 [features]
 default = ["snappy", "lz4", "zstd", "zlib", "bzip2", "bindgen-runtime"]
 jemalloc = ["librocksdb-sys/jemalloc"]
@@ -39,7 +42,7 @@ raw-ptr = []
 
 [dependencies]
 libc = "0.2"
-librocksdb-sys = { path = "librocksdb-sys", version = "0.18.0", default-features = false, features = [
+librocksdb-sys = { path = "librocksdb-sys", version = "0.18.0", package = "surrealdb-librocksdb-sys", default-features = false, features = [
     "static",
 ] }
 serde = { version = "1", features = ["derive"], optional = true }

MAINTAINERSHIP.md

@@ -1,3 +1,5 @@
+> **Note**: This maintainership document is inherited from the upstream [rust-rocksdb](https://github.com/rust-rocksdb/rust-rocksdb) project and serves as a reference for this SurrealDB fork. Governance and processes may be adapted to align with SurrealDB's standards.
+
 Maintainers agree to operate under this set of guidelines:
 
 #### Authority
@@ -10,7 +12,7 @@ Maintainers are trusted to close issues, merge pull requests, and publish crates
     * updating the changelog
     * requires no approval
 1. Normal
-    * librocksdb-sys updates
+    * surrealdb-librocksdb-sys updates
     * API tracking code in the rocksdb crate that does not change control flow
     * breaking changes due to removed functionality in rocksdb
     * require 1 approval from another maintainer. if no maintainer is able to be reached for 2 weeks, then progress may be made anyway

README.md

@@ -1,13 +1,18 @@
 # rust-rocksdb
 
-[![RocksDB build](https://github.com/rust-rocksdb/rust-rocksdb/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/rust-rocksdb/rust-rocksdb/actions/workflows/rust.yml)
-[![crates.io](https://img.shields.io/crates/v/rocksdb.svg)](https://crates.io/crates/rocksdb)
-[![documentation](https://img.shields.io/docsrs/rocksdb/latest)](https://docs.rs/rocksdb)
-[![license](https://img.shields.io/crates/l/rocksdb.svg)](https://github.com/rust-rocksdb/rust-rocksdb/blob/master/LICENSE)
-[![Gitter chat](https://badges.gitter.im/rust-rocksdb/gitter.svg)](https://gitter.im/rust-rocksdb/lobby)
+[![RocksDB build](https://github.com/surrealdb/rust-rocksdb/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/surrealdb/rust-rocksdb/actions/workflows/rust.yml)
+[![crates.io](https://img.shields.io/crates/v/surrealdb-rocksdb.svg)](https://crates.io/crates/surrealdb-rocksdb)
+[![documentation](https://img.shields.io/docsrs/surrealdb-rocksdb/latest)](https://docs.rs/surrealdb-rocksdb)
+[![license](https://img.shields.io/crates/l/surrealdb-rocksdb.svg)](https://github.com/surrealdb/rust-rocksdb/blob/master/LICENSE)
 ![rust 1.85.0 required](https://img.shields.io/badge/rust-1.85.0-blue.svg?label=MSRV)
 
-![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/rust-rocksdb/rust-rocksdb/latest.svg)
+![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/surrealdb/rust-rocksdb/latest.svg)
+
+> [!NOTE]
+> - The `master` branch is an up-to-date sync from the upstream [rust-rocksdb](https://github.com/rust-rocksdb/rust-rocksdb) repository.
+> - The `main` branch is rebased from `master` with packaging changes to publish as `surrealdb-rocksdb` on crates.io (the library name remains `rocksdb`, so existing `use rocksdb::*` imports work unchanged).
+> - Release branches (e.g. `0.24.0-surreal`) are rebased from `main`, one per published version.
+> - For bugs unrelated to packaging, please report them [upstream](https://github.com/rust-rocksdb/rust-rocksdb/issues).
 
 ## Requirements
 
@@ -29,6 +34,12 @@ compression submodules:
 git submodule update --init --recursive
 ```
 
+To update the RocksDB submodule to the latest commit on its tracked branch:
+
+```shell
+git submodule update --init --recursive --remote librocksdb-sys/rocksdb
+```
+
 ## Compression Support
 
 By default, support for [Snappy](https://github.com/google/snappy),
@@ -40,7 +51,7 @@ compression algorithms can be enabled. For example, to enable only LZ4
 compression support, make these changes to your Cargo.toml:
 
 ```toml
-[dependencies.rocksdb]
+[dependencies.surrealdb-rocksdb]
 default-features = false
 features = ["lz4"]
 ```
@@ -71,7 +82,7 @@ links to libclang. This is suitable for musllinux platforms, such as Alpine linu
 To build on Alpine linux for example, make these changes to your Cargo.toml:
 
 ```toml
-[dependencies.rocksdb]
+[dependencies.surrealdb-rocksdb]
 default-features = false
 features = ["bindgen-static", "snappy", "lz4", "zstd", "zlib", "bzip2"]
 ```

librocksdb-sys/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "librocksdb-sys"
+name = "surrealdb-librocksdb-sys"
 version = "0.18.0+10.7.5"
 edition = "2021"
 rust-version = "1.85.0"
@@ -10,10 +10,30 @@ authors = [
 license = "MIT/Apache-2.0/BSD-3-Clause"
 description = "Native bindings to librocksdb"
 readme = "README.md"
-repository = "https://github.com/rust-rocksdb/rust-rocksdb"
+repository = "https://github.com/surrealdb/rust-rocksdb"
 keywords = ["bindings", "ffi", "rocksdb"]
 categories = ["api-bindings", "database", "external-ffi-bindings"]
 links = "rocksdb"
+include = [
+    "/src/**/*",
+    "/tests/**/*",
+    "/build.rs",
+    "/rocksdb/**/*",
+    "/snappy/**/*",
+    "/build_version.cc",
+    "/rocksdb_lib_sources.txt",
+    "/snappy-stubs-public.h",
+    "/README.md",
+    "/Cargo.toml",
+    "!**/.git/**",
+    "!/rocksdb/docs/**",
+    "!/rocksdb/examples/**",
+    "!/snappy/docs/**",
+    "!/snappy/testdata/**",
+]
+
+[lib]
+name = "librocksdb_sys"
 
 [features]
 default = ["static", "bindgen/runtime"]

librocksdb-sys/README.md

@@ -9,6 +9,6 @@ https://github.com/jsgf/rocksdb-sys
 
 ### Version
 
-The librocksdb-sys version number is in the format `X.Y.Z+RX.RY.RZ`, where
+The surrealdb-librocksdb-sys version number is in the format `X.Y.Z+RX.RY.RZ`, where
 `X.Y.Z` is the version of this crate and follows SemVer conventions, while
 `RX.RY.RZ` is the version of the bundled rocksdb.