search

tikv / pprof-rs

A Rust CPU profiler implemented with the help of backtrace-rs
Apache License 2.0
1.26k stars 94 forks source link

Documentation and error message for protobuf features should be made more clear #246

Open NexVeridian opened 2 months ago

NexVeridian commented 2 months ago

In the readme it says to use feature protobuf https://github.com/tikv/pprof-rs/blob/4939f73f0cc2e8d92e3c2c50c9d02d6d4c205a86/README.md?plain=1#L119-L121

but when compiling criterion with feature protobuf, you get this error pprof = { version = "0.13", features = ["criterion", "protobuf"] }

https://github.com/tikv/pprof-rs/blob/4939f73f0cc2e8d92e3c2c50c9d02d6d4c205a86/src/criterion.rs#L48-L49

Feature protobuf doesn't include feature _protobuf

I think the both of these two spots should be changed to "use feature prost-codec or protobuf-codec"