jimblandy / perf-event

perf-event: a Rust interface to Linux performance monitoring
Apache License 2.0
111 stars 19 forks source link

Don't copy GPL'd man page text into doc comments #24

Closed jimblandy closed 2 years ago

jimblandy commented 2 years ago

Many of the doc comments for specific events in events.rs are lifted verbatim from the perf_event_open man page, which is licensed under the GPL. The GPL is incompatible with this crate's license, so the comments need to be removed.

Trying to rewrite such detailed documentation in our own words will take a huge amount of time, and will likely introduce errors. I think our best option is to simply use names in our API that are easy to look up in the man page, and repeatedly link to http://man7.org/linux/man-pages/man2/perf_event_open.2.html.