README snippets seem to be outdated #32
Assignees
Comments
danielocfb
pushed a commit
to danielocfb/blazesym
that referenced
this issue
Dec 8, 2022
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
danielocfb
pushed a commit
to danielocfb/blazesym
that referenced
this issue
Dec 8, 2022
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
danielocfb
pushed a commit
to danielocfb/blazesym
that referenced
this issue
Dec 8, 2022
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
danielocfb
pushed a commit
to danielocfb/blazesym
that referenced
this issue
Dec 9, 2022
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Also tag Rust code snippets as Rust code and C snippets as C. That has both the effect that it will ensure proper handling of doc tests (C snippets are ignored) while providing correct syntax highlighting. Note that not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI by tagging them with `no_run` instead of `ignore`. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
danielocfb
pushed a commit
to danielocfb/blazesym
that referenced
this issue
Dec 9, 2022
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Also tag Rust code snippets as Rust code and C snippets as C. That has both the effect that it will ensure proper handling of doc tests (C snippets are ignored) while providing correct syntax highlighting. Note that not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI by tagging them with `no_run` instead of `ignore`. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As mentioned in #27, it appears as if the snippets illustrating the crate's API in the README are broken. We should probably update them to work against the new API and make sure to test everything in CI.
The text was updated successfully, but these errors were encountered: