diff --git a/doc/ref/scheme-options.texi b/doc/ref/scheme-options.texi index 0492ce9ed..41b606286 100644 --- a/doc/ref/scheme-options.texi +++ b/doc/ref/scheme-options.texi @@ -43,20 +43,40 @@ Guile was configured, built and installed on your system. @deffnx {Scheme Procedure} minor-version @deffnx {Scheme Procedure} micro-version @deffnx {C Function} scm_version () +@deffnx {C Function} scm_effective_version () @deffnx {C Function} scm_major_version () @deffnx {C Function} scm_minor_version () @deffnx {C Function} scm_micro_version () Return a string describing Guile's version number, or its major, minor -or micro version number, respectively. +or micro version number, respectively. The @code{effective-version} +function returns the version name that should remain unchanged during +a stable series. Currently that means that it omits the micro +version. It should be used for things like the versioned share +directory name i.e. @file{/usr/share/guile/1.6/} @lisp (version) @result{} "1.6.0" +(effective-version) @result{} "1.6" (major-version) @result{} "1" (minor-version) @result{} "6" (micro-version) @result{} "0" @end lisp @end deffn +@deffn {Scheme Procedure} effective-version +@deffnx {C Function} scm_effective_version () +Return a string describing Guile's ``effective'' version number, one +that should remain unchanged during a stable series. Currently that +means that it is the same as the result of @code{version} but without +the micro version. It should be used for things like the versioned +share directory name i.e. @file{/usr/share/guile/1.6/}. + +@lisp +(version) @result{} "1.6.0" +(effective-version) @result{} "1.6" +@end lisp +@end deffn + @deffn {Scheme Procedure} %package-data-dir @deffnx {C Function} scm_sys_package_data_dir () Return the name of the directory under which Guile Scheme files in @@ -71,7 +91,7 @@ belong to the core Guile installation (as opposed to files from a 3rd party package) are installed. On Unix-like systems, this is usually @file{/usr/local/share/guile/} or @file{/usr/share/guile/}, for example: -@file{/usr/local/share/guile/1.6.0}. +@file{/usr/local/share/guile/1.6}. @end deffn @deffn {Scheme Procedure} %site-dir