core: rename gpiod_version_string() to gpiod_api_version()

Instead of telling the user what type this function returns (they can
check it by looking at the prototype), tell them what the return value
actually represents.

Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

diff --git a/bindings/cxx/gpiodcxx/misc.hpp b/bindings/cxx/gpiodcxx/misc.hpp
index ee52eabecb3a4fffbf9cc945950386cee997eddd..1e41e9b0a794c00c9e0bbbafbc57df68d94a16cf 100644 (file)
--- a/bindings/cxx/gpiodcxx/misc.hpp
+++ b/bindings/cxx/gpiodcxx/misc.hpp
@@ -33,7 +33,7 @@ bool is_gpiochip_device(const ::std::filesystem::path& path);
  * @brief Get the human readable version string for libgpiod API
  * @return String containing the library version.
  */
-const ::std::string& version_string();
+const ::std::string& api_version();
 
 /**
  * @}

diff --git a/bindings/cxx/misc.cpp b/bindings/cxx/misc.cpp
index 773cfbfb88bbfad0e2709a301a67ec6f6a62c34a..dde48e0e4024d8e2de73a68dd85250ba31a6a5d3 100644 (file)
--- a/bindings/cxx/misc.cpp
+++ b/bindings/cxx/misc.cpp
@@ -10,9 +10,9 @@ GPIOD_CXX_API bool is_gpiochip_device(const ::std::filesystem::path& path)
        return ::gpiod_is_gpiochip_device(path.c_str());
 }
 
-GPIOD_CXX_API const ::std::string& version_string()
+GPIOD_CXX_API const ::std::string& api_version()
 {
-       static const ::std::string version(::gpiod_version_string());
+       static const ::std::string version(::gpiod_api_version());
 
        return version;
 }

diff --git a/bindings/cxx/tests/tests-misc.cpp b/bindings/cxx/tests/tests-misc.cpp
index fe8cdeab33fb56f54d67741de4bf63d7ed1ba030..0a2c5632d542cbf3a30ba4e36f2b0932d4e1501b 100644 (file)
--- a/bindings/cxx/tests/tests-misc.cpp
+++ b/bindings/cxx/tests/tests-misc.cpp
@@ -66,11 +66,11 @@ TEST_CASE("is_gpiochip_device() works", "[misc][chip]")
        }
 }
 
-TEST_CASE("version_string() returns a valid API version", "[misc]")
+TEST_CASE("api_version() returns a valid API version", "[misc]")
 {
-       SECTION("check version_string() format")
+       SECTION("check api_version() format")
        {
-               REQUIRE_THAT(::gpiod::version_string(),
+               REQUIRE_THAT(::gpiod::api_version(),
                             regex_matcher("^[0-9][1-9]?\\.[0-9][1-9]?([\\.0-9]?|\\-devel)$"));
        }
 }

diff --git a/bindings/python/gpiod/ext/module.c b/bindings/python/gpiod/ext/module.c
index 8b5a032d2ca22a336c49f3d97d365f4e689af3d8..101d7568e46f33a4e4e367b9884d9b9c3ba24eaa 100644 (file)
--- a/bindings/python/gpiod/ext/module.c
+++ b/bindings/python/gpiod/ext/module.c
@@ -166,7 +166,7 @@ PyMODINIT_FUNC PyInit__ext(void)
                return NULL;
 
        ret = PyModule_AddStringConstant(module, "api_version",
-                                        gpiod_version_string());
+                                        gpiod_api_version());
        if (ret) {
                Py_DECREF(module);
                return NULL;

diff --git a/bindings/rust/libgpiod/src/lib.rs b/bindings/rust/libgpiod/src/lib.rs
index 1b2c7656daa4e739becfce3c8e07aebd39db64c0..a5d018cab73e5e180339ea814ab47db9538b08b2 100644 (file)
--- a/bindings/rust/libgpiod/src/lib.rs
+++ b/bindings/rust/libgpiod/src/lib.rs
@@ -495,7 +495,7 @@ pub fn gpiochip_devices<P: AsRef<Path>>(path: &P) -> Result<Vec<chip::Chip>> {
 /// Get the API version of the libgpiod library as a human-readable string.
 pub fn libgpiod_version() -> Result<&'static str> {
     // SAFETY: The string returned by libgpiod is guaranteed to live forever.
-    let version = unsafe { gpiod::gpiod_version_string() };
+    let version = unsafe { gpiod::gpiod_api_version() };
 
     if version.is_null() {
         return Err(Error::NullString("GPIO library version"));

diff --git a/include/gpiod.h b/include/gpiod.h
index a76c311c0ddf18eaed7f8ba283db4b2f2f09ce44..56c182f9d3fbc608e34ba89c3c4bdcd2a5ffe7f5 100644 (file)
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -1182,7 +1182,7 @@ bool gpiod_is_gpiochip_device(const char *path);
  *        version.  The pointer is valid for the lifetime of the program and
  *        must not be freed by the caller.
  */
-const char *gpiod_version_string(void);
+const char *gpiod_api_version(void);
 
 /**
  * @}

diff --git a/lib/misc.c b/lib/misc.c
index b0899b38ed158b7d22dc1c5ef36ae6bde32d8613..e109f8086b4c22edccfb5e88b89e4bf2fac4feee 100644 (file)
--- a/lib/misc.c
+++ b/lib/misc.c
@@ -10,7 +10,7 @@ GPIOD_API bool gpiod_is_gpiochip_device(const char *path)
        return gpiod_check_gpiochip_device(path, false);
 }
 
-GPIOD_API const char *gpiod_version_string(void)
+GPIOD_API const char *gpiod_api_version(void)
 {
        return GPIOD_VERSION_STR;
 }

diff --git a/tests/tests-misc.c b/tests/tests-misc.c
index d3c9a824be53a3b3112d719a60667a6d8a51ace1..0a3587df46a7bec8b70ae785681f1747e41d763a 100644 (file)
--- a/tests/tests-misc.c
+++ b/tests/tests-misc.c
@@ -70,7 +70,7 @@ GPIOD_TEST_CASE(version_string)
        const gchar *ver;
        gboolean ret;
 
-       ver = gpiod_version_string();
+       ver = gpiod_api_version();
        g_assert_nonnull(ver);
        gpiod_test_return_if_failed();
 

diff --git a/tools/tools-common.c b/tools/tools-common.c
index 3480ede3bc834fb2536d797967bc92d9ae440cb8..cb8491be57b0aa210f23d09693a654b7f8aa5dd8 100644 (file)
--- a/tools/tools-common.c
+++ b/tools/tools-common.c
@@ -76,7 +76,7 @@ void die_perror(const char *fmt, ...)
 void print_version(void)
 {
        printf("%s (libgpiod) v%s\n",
-              program_invocation_short_name, gpiod_version_string());
+              program_invocation_short_name, gpiod_api_version());
        printf("Copyright (C) 2017-2018 Bartosz Golaszewski\n");
        printf("License: GPL-2.0-or-later\n");
        printf("This is free software: you are free to change and redistribute it.\n");