diff options
author | Michael Oultram <michael.oultram@pexip.com> | 2022-10-19 13:34:21 +0300 |
---|---|---|
committer | Michael Oultram <michael.oultram@pexip.com> | 2022-10-19 13:38:36 +0300 |
commit | e0437ae8f63679d32986517c012c0ec2e26a6d51 (patch) | |
tree | 51a14dc4829735bf4d45a49b2461d32348d9c18d | |
parent | 59daaa62aa4b7f9de6a50e070a63e778ed344cb6 (diff) |
docs: fix references to renamed function gst_plugin_version_helper::get_info()
-rw-r--r-- | tutorial/tutorial-1.md | 4 | ||||
-rw-r--r-- | version-helper/README.md | 2 | ||||
-rw-r--r-- | version-helper/src/lib.rs | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/tutorial/tutorial-1.md b/tutorial/tutorial-1.md index 1ebc61f0..d80d9b81 100644 --- a/tutorial/tutorial-1.md +++ b/tutorial/tutorial-1.md @@ -105,13 +105,13 @@ Next we create `build.rs` in the project main directory. ```rust fn main() { - gst_plugin_version_helper::get_info() + gst_plugin_version_helper::info() } ``` `build.rs` compiles and runs before anything else, [see](https://doc.rust-lang.org/cargo/reference/build-scripts.html). -Therefore, `gst_plugin_version_helper::get_info()` will provide various information via `cargo` environment variables such as `COMMIT_ID` and `BUILD_REL_DATE` and these environment variables are then later accessed by our invocation of the `gst::plugin_define!` macro during compilation. +Therefore, `gst_plugin_version_helper::info()` will provide various information via `cargo` environment variables such as `COMMIT_ID` and `BUILD_REL_DATE` and these environment variables are then later accessed by our invocation of the `gst::plugin_define!` macro during compilation. In addition we’re defining an empty plugin entry point function that just returns `Ok(())` diff --git a/version-helper/README.md b/version-helper/README.md index ad69ae5b..0b84ce15 100644 --- a/version-helper/README.md +++ b/version-helper/README.md @@ -11,7 +11,7 @@ plugin: gst_plugin_version_helper::info(); ``` -Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows: +Inside `lib.rs` of the plugin, the information provided by `info` are usable as follows: ```rust,ignore gst::plugin_define!( diff --git a/version-helper/src/lib.rs b/version-helper/src/lib.rs index 6e2d10cb..ccd90f63 100644 --- a/version-helper/src/lib.rs +++ b/version-helper/src/lib.rs @@ -7,7 +7,7 @@ //! Extracts release for [GStreamer](https://gstreamer.freedesktop.org) plugin metadata //! -//! See [`get_info`](fn.get_info.html) for details. +//! See [`info`](fn.info.html) for details. //! //! This function is supposed to be used as follows in the `build.rs` of a crate that implements a //! plugin: @@ -16,7 +16,7 @@ //! gst_plugin_version_helper::info(); //! ``` //! -//! Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows: +//! Inside `lib.rs` of the plugin, the information provided by `info` are usable as follows: //! //! ```rust,ignore //! gst::plugin_define!( |