From 6946fe71047e633972e88c9bed47ef27a29bd9af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Baylac=20Jacqu=C3=A9?= Date: Tue, 6 Feb 2024 14:07:19 +0100 Subject: [PATCH] TOREMOVE: readme --- README.md | 43 ++++++++++++++----------------------------- 1 file changed, 14 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e1cace3b4..b6241c889 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,19 @@ -# Nix +# Nix Profiled With Tracy -[![Open Collective supporters](https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporters&color=brightgreen)](https://opencollective.com/nixos) -[![Test](https://github.com/NixOS/nix/workflows/Test/badge.svg)](https://github.com/NixOS/nix/actions) +## Profiling Idea -Nix is a powerful package manager for Linux and other Unix systems that makes package -management reliable and reproducible. Please refer to the [Nix manual](https://nixos.org/nix/manual) -for more details. +TODO: explain -## Installation and first steps +- Tracing thunk force operations. +- Eval is single-threaded and recursive: easy to build stack frames + out of global eval state. +- Profiling infos are streamed to tracy server in that prototype. +- In previous iterations, we tried: + - keep the profile in memory and save it to memory in a previous iteration. See [andir's version](https://git.alternativebit.fr/picnoir/Nix/src/branch/pic/tracy-on-top-of-andi) for code/more infos. + - eBPF approach using USDTs (through bcc). We kept over-running the kernel/userspace ring buffer. See [here](https://git.alternativebit.fr/picnoir/Nix/src/branch/nin/usdt-rust) for more infos/code. -Visit [nix.dev](https://nix.dev) for [installation instructions](https://nix.dev/tutorials/install-nix) and [beginner tutorials](https://nix.dev/tutorials/first-steps). +## TODOs -Full reference documentation can be found in the [Nix manual](https://nixos.org/nix/manual). - -## Building And Developing - -See our [Hacking guide](https://nixos.org/manual/nix/unstable/contributing/hacking.html) in our manual for instruction on how to - set up a development environment and build Nix from source. - -## Contributing - -Check the [contributing guide](./CONTRIBUTING.md) if you want to get involved with developing Nix. - -## Additional Resources - -- [Nix manual](https://nixos.org/nix/manual) -- [Nix jobsets on hydra.nixos.org](https://hydra.nixos.org/project/nix) -- [NixOS Discourse](https://discourse.nixos.org/) -- [Matrix - #nix:nixos.org](https://matrix.to/#/#nix:nixos.org) - -## License - -Nix is released under the [LGPL v2.1](./COPYING). +- Add config flag to enable tracing. +- Remove tracy submodule approach, inject it through Nix. +-