[][src]Function built::util::get_repo_description

pub fn get_repo_description(
    root: &Path
) -> Result<Option<(String, bool)>, Error>

Retrieves the git-tag or hash describing the exact version and a boolean that indicates if the repository currently has dirty/staged files.

If a valid git-repo can't be discovered at or above the given path, Ok(None) is returned instead of an Err-value.

Errors

Errors from git2 are returned if the repository does exists at all.