Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
Move RocksDB to a Git Submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
filoozom committed Nov 1, 2018
1 parent 7b4e85f commit 608e26e
Show file tree
Hide file tree
Showing 6 changed files with 428 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "deps/rocksdb/rocksdb"]
path = deps/rocksdb/rocksdb
url = https://github.com/facebook/rocksdb.git
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,27 @@ There are multiple ways you can find help in using LevelDB in Node.js:
See the [contribution guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

### Git Submodules

This project uses Git Submodules. This means that you should clone it recursively if you're planning on working on it:

```bash
$ git clone --recurse-submodules https://github.com/Level/leveldown.git
```

Alternatively, you can initalize submodules inside the cloned folder:

```bash
$ git submodule update --init --recursive
```

### Windows

A large portion of the Windows support comes from code by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) [@kjk](https://twitter.com/kjk), see his Windows LevelDB port [here](http://code.google.com/r/kkowalczyk-leveldb/). If you're using LevelUP on Windows, you should give him your thanks!

## Prebuilt Binaries

`rocksdb` uses `prebuild` and `prebuild-install` for handling prebuilt binaries. See [this list](https://github.com/Level/rocksdb/releases) of supported prebuilt platform binaries. When installing rocksdb `prebuild-install` will install prebuilt binaries from GitHub if they exist and fallback to a compile step if they don't.
`rocksdb` uses `prebuild` and `prebuild-install` for handling prebuilt binaries. See [this list](https://github.com/Level/rocksdb/releases) of supported prebuilt platform binaries. When installing rocksdb `prebuild-install` will install prebuilt binaries from GitHub if they exist and fallback to a compile step if they don't.

If you are working on `rocksdb` and want to re-compile the C++ code it's enough to do `npm install`.

Expand All @@ -72,4 +86,4 @@ Copyright © 2012-present `rocksdb` [contributors](https://github.com/level/

`rocksdb` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors to the LevelDB fork by Facebook. LevelDB and Snappy are both issued under the [New BSD Licence](http://opensource.org/licenses/BSD-3-Clause).

[level-badge]: http://leveldb.org/img/badge.svg
[level-badge]: http://leveldb.org/img/badge.svg
2 changes: 1 addition & 1 deletion binding.gyp
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
}]
]
, "dependencies": [
"<(module_root_dir)/deps/leveldb/leveldb.gyp:leveldb"
"<(module_root_dir)/deps/rocksdb/rocksdb.gyp:rocksdb"
]
, "include_dirs" : [
"<!(node -e \"require('nan')\")"
Expand Down
1 change: 1 addition & 0 deletions deps/rocksdb/rocksdb
Submodule rocksdb added at 4e0065
Loading

0 comments on commit 608e26e

Please sign in to comment.