Document how to tell if your build is fixed-point.
authorTimothy B. Terriberry <tterribe@xiph.org>
Fri, 20 Feb 2015 20:44:10 +0000 (12:44 -0800)
committerTimothy B. Terriberry <tterribe@xiph.org>
Fri, 20 Feb 2015 20:44:10 +0000 (12:44 -0800)
This way we won't break this by accident.

celt/celt.c
include/opus_defines.h

index c0a1e0d..a610de4 100644 (file)
@@ -280,6 +280,9 @@ const char *opus_strerror(int error)
 const char *opus_get_version_string(void)
 {
     return "libopus " PACKAGE_VERSION
+    /* Applications may rely on the presence of this substring in the version
+       string to determine if they have a fixed-point or floating-point build
+       at runtime. */
 #ifdef FIXED_POINT
           "-fixed"
 #endif
index 32b7c97..41e81f0 100644 (file)
@@ -714,6 +714,10 @@ OPUS_EXPORT const char *opus_strerror(int error);
 
 /** Gets the libopus version string.
   *
+  * Applications may look for the substring "-fixed" in the version string to
+  * determine whether they have a fixed-point or floating-point build at
+  * runtime.
+  *
   * @returns Version string
   */
 OPUS_EXPORT const char *opus_get_version_string(void);