Skip to content

gstreamer/lib: Prevent `fn deinit()` docs from being stripped

Marijn Suijten requested to merge MarijnS95/gstreamer-rs:gstreamer-rustdoc-stripper-ignore-next into master

https://gstreamer.pages.freedesktop.org/gstreamer-rs/gstreamer/fn.deinit.html This function has no docs back on the old build.rs purge+embed setup.

Notice that the only other documentation lives in gl_memory.rs/gl_filter.rs and is properly annotated with // rustdoc-stripper-ignore-next too, and there are a few more in clock_time.rs which are not guarded but not stripped either?! Anyone have an idea why? Tried with things like this:

export PATH=~/.cargo/bin:$PATH
rustdoc-stripper -d gstreamer/src -s
rustdoc-stripper -d gstreamer/src -s -m
rustdoc-stripper -d gstreamer/src -s -m -n
rustdoc-stripper -d gstreamer/src -s -n

I know those options shouldn't have any effect, and they don't :)

The CI is also taught to strip docs and diff the result, ensuring no doc comments are left unguarded. A test-run before fixing gstreamer will show up in https://gitlab.freedesktop.org/MarijnS95/gstreamer-rs/-/jobs/9470359, 🙏 that it works :)

We should hold off merging until a gir update, and confirmation that the CI works as intended.

TODO: Perhaps we can/should install rustdoc-stripper in .img-nightly instead of installing it twice? That's quite costly.

Edited by Marijn Suijten

Merge request reports