aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/lib.rs5
-rw-r--r--tests/lib.rs3
2 files changed, 4 insertions, 4 deletions
diff --git a/src/lib.rs b/src/lib.rs
index c4e55b1..02a622b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -111,12 +111,13 @@ pub use crate::util::{CommandError, LogLevel};
/// version.
#[derive(Clone, Debug, PartialEq)]
pub struct Version {
- /// The library version as a string.
+ /// The Git library version as a string.
///
/// The library version is the output of `git describe --always` at compile time, for example
/// `v3.3` or `v3.4.1`. If the library has not been built from a release, the version string
/// contains the number of commits since the last release and the hash of the current commit, for
- /// example `v3.3-19-gaee920b`.
+ /// example `v3.3-19-gaee920b`. If the library has not been built from a Git checkout, this
+ /// string may be empty.
pub git: String,
/// The major library version.
pub major: u32,
diff --git a/tests/lib.rs b/tests/lib.rs
index 06de0ad..c92e224 100644
--- a/tests/lib.rs
+++ b/tests/lib.rs
@@ -2,7 +2,6 @@
fn get_library_version() {
let version = nitrokey::get_library_version();
- assert!(!version.git.is_empty());
- assert!(version.git.starts_with("v"));
+ assert!(version.git.is_empty() || version.git.starts_with("v"));
assert!(version.major > 0);
}