TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
conduit/docs/development.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

40 lines
2.5 KiB
Markdown
Raw Normal View History

use `lib.makeScope` and files to organize packages Some of the improvements here include: * rocksdb can actually use jemalloc now instead of just pulling in a second rocksdb for no reason * "complement-runtime" factored back out into shell file * complement image no longer uses `mkDerivation` for `copyToRoot` because that's what `buildEnv` is for * complement image no longer sets `SERVER_NAME`, complement already does that * all packages were factored out into `callPackage`-able files for use with a custom `lib.makeScope pkgs.newScope` * new version of `mkPackage` has options that are easier to use and override such as `features`
2024-04-22 00:28:35 +02:00
# Development
Information about developing the project. If you are only interested in using
add a contributing guide Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-05-04 19:24:25 +02:00
it, you can safely ignore this section. If you plan on contributing, see the
[contributor's guide](contributing.md).
add optional support for tokio-console This turned out to be quite hairy, mostly because we need to apply the config's log level filter to the actual logs (stdout and, optionally sentry), but do not want to filter out the tokio tracing events needed by the console_subscriber. I hit several edge cases in tracing getting this to work, and we now depend on a git version of tracing with a backported patch :(
2024-04-25 18:07:59 +02:00
docs: document list of projects conduwuit has forked Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-08-18 23:54:05 +02:00
## List of forked dependencies
During conduwuit development, we have had to fork some dependencies to support our use-cases in some areas. This ranges from things said upstream project won't accept for any reason, faster-paced development (unresponsive or slow upstream), conduwuit-specific usecases, or lack of time to upstream some things.
- [ruma/ruma][1]: <https://github.com/girlbossceo/ruwuma> - various performance improvements, more features, faster-paced development, client/server interop hacks upstream won't accept, etc
- [facebook/rocksdb][2]: <https://github.com/girlbossceo/rocksdb> - liburing build fixes, GCC build fix, and logging callback C API for Rust tracing integration
- [tikv/jemallocator][3]: <https://github.com/girlbossceo/jemallocator> - musl builds seem to be broken on upstream
- [zyansheep/rustyline-async][4]: <https://github.com/girlbossceo/rustyline-async> - tab completion callback and `CTRL+\` signal quit event for CLI
- [rust-rocksdb/rust-rocksdb][5]: <https://github.com/girlbossceo/rust-rocksdb-zaidoon1> - [`@zaidoon1`'s][8] fork has quicker updates, more up to date dependencies. Our changes fix musl build issues, Rust part of the logging callback C API, removes unnecessary `gtest` include, and uses our RocksDB and jemallocator
- [tokio-rs/tracing][6]: <https://github.com/girlbossceo/tracing> - Implements `Clone` for `EnvFilter` to support dynamically changing tracing envfilter's alongside other logging/metrics things
add optional support for tokio-console This turned out to be quite hairy, mostly because we need to apply the config's log level filter to the actual logs (stdout and, optionally sentry), but do not want to filter out the tokio tracing events needed by the console_subscriber. I hit several edge cases in tracing getting this to work, and we now depend on a git version of tracing with a backported patch :(
2024-04-25 18:07:59 +02:00
## Debugging with `tokio-console`
docs: document list of projects conduwuit has forked Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-08-18 23:54:05 +02:00
[`tokio-console`][7] can be a useful tool for debugging and profiling. To make
docs: more improvements, fixes, cleanup, etc Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-06-17 03:30:51 +02:00
a `tokio-console`-enabled build of conduwuit, enable the `tokio_console` feature,
add optional support for tokio-console This turned out to be quite hairy, mostly because we need to apply the config's log level filter to the actual logs (stdout and, optionally sentry), but do not want to filter out the tokio tracing events needed by the console_subscriber. I hit several edge cases in tracing getting this to work, and we now depend on a git version of tracing with a backported patch :(
2024-04-25 18:07:59 +02:00
disable the default `release_max_log_level` feature, and set the
`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
look like this:
```bash
RUSTFLAGS="--cfg tokio_unstable" cargo build \
--release \
--no-default-features \
slight docs updates Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-07-03 19:16:27 +02:00
--features=systemd,element_hacks,gzip_compression,brotli_compression,zstd_compression,tokio_console
add optional support for tokio-console This turned out to be quite hairy, mostly because we need to apply the config's log level filter to the actual logs (stdout and, optionally sentry), but do not want to filter out the tokio tracing events needed by the console_subscriber. I hit several edge cases in tracing getting this to work, and we now depend on a git version of tracing with a backported patch :(
2024-04-25 18:07:59 +02:00
```
docs: document list of projects conduwuit has forked Signed-off-by: strawberry <strawberry@puppygock.gay>
2024-08-18 23:54:05 +02:00
[1]: https://github.com/ruma/ruma/
[2]: https://github.com/facebook/rocksdb/
[3]: https://github.com/tikv/jemallocator/
[4]: https://github.com/zyansheep/rustyline-async/
[5]: https://github.com/rust-rocksdb/rust-rocksdb/
[6]: https://github.com/tokio-rs/tracing/
[7]: https://docs.rs/tokio-console/latest/tokio_console/
[8]: https://github.com/zaidoon1/
Reference in a new issue Copy permalink