[librsvgmm] Document compile-binding.am variables

[Daniel Elstner <daniel src gnome org>]

commit ce2a73ac25e8892a6c57938ea3ec6c9a80f64839
Author: Daniel Elstner <danielk openismus com>
Date:   Tue Aug 4 10:14:05 2009 +0200

    Document compile-binding.am variables
    
    * build/compile-binding.am: Document the purpose of the input and
    output variables defined in this Automake include file.

 build/compile-binding.am |   43 ++++++++++++++++++++++++++++++-------------
 1 files changed, 30 insertions(+), 13 deletions(-)
---
diff --git a/build/compile-binding.am b/build/compile-binding.am
index 8f6145e..83ee5ec 100644
--- a/build/compile-binding.am
+++ b/build/compile-binding.am
@@ -16,27 +16,44 @@
 ## along with mm-autofu.  If not, see <http://www.gnu.org/licenses/>.
 
 ## Parameters:  lib_LTLIBRARIES
-## Overrides:   binding_name, binding_basedir, binding_libname
+## Overrides:   binding_name, binding_basedir, binding_modulename
 ## Files:       files_built_cc, files_built_h, files_built_ph,
 ##              files_extra_cc, files_extra_h
 ## Output:      binding_sources, binding_includes, binding_cppflags
 
-binding_name		?= $(notdir $(subdir))
-binding_basedir		?= $(patsubst %/,%,$(dir $(subdir)))
-binding_libname		?= $(basename $(lib_LTLIBRARIES))
+# The name of the binding module.  Usually identical to the name of the
+# directory where the generated sources and include files live.
+binding_name ?= $(notdir $(subdir))
 
-binding_sources		= $(files_built_cc) $(files_extra_cc)
-binding_includes	= -I.. -I$(top_srcdir)/$(binding_basedir) -I$(top_builddir)
-binding_cppflags	= -DG_LOG_DOMAIN=\""$(binding_name)"\"
+# The parent directory of the src/ and libmm/ directories.
+# Usually the same as the C library name.
+binding_basedir ?= $(patsubst %/,%,$(dir $(subdir)))
 
-binding_includedir	= $(includedir)/$(binding_libname)/$(binding_name)
-binding_include_HEADERS	= $(files_built_h) $(files_extra_h)
+# The library name of the binding, possibly including an API version suffix.
+# Depending on the module, the "lib" prefix may or may not be included.
+binding_modulename ?= $(patsubst lib%,$(binding_libprefix)%,$(basename $(lib_LTLIBRARIES)))
 
-binding_privatedir	= $(binding_includedir)/private
-binding_private_HEADERS	= $(files_built_ph)
+# Try to work out whether the binding's module name includes a "lib" prefix.
+binding_libprefix = $(if $(binding_name:lib%=),,lib)
 
-binding_built_sources	= $(files_built_cc) $(files_built_h) $(files_built_ph)
-MAINTAINERCLEANFILES	= $(addprefix $(srcdir)/,$(binding_built_sources))
+# Files to be listed in the module's _SOURCES variable.
+binding_sources = $(files_built_cc) $(files_extra_cc)
+
+# Default include directories and preprocessor flags.
+binding_includes = -I.. $(if $(srcdir:.=),-I$(top_srcdir)/$(binding_basedir)) -I$(top_builddir)
+binding_cppflags = -DG_LOG_DOMAIN=\""$(binding_name)"\"
+
+# Installation directories for header files.
+binding_includedir = $(includedir)/$(binding_modulename)/$(binding_name)
+binding_privatedir = $(binding_includedir)/private
+
+# List of installed header files.
+binding_include_HEADERS = $(files_built_h) $(files_extra_h)
+binding_private_HEADERS = $(files_built_ph)
+
+# Delete built sources on make maintainer-clean.
+binding_built_sources = $(files_built_cc) $(files_built_h) $(files_built_ph)
+MAINTAINERCLEANFILES  = $(binding_built_sources) $(addprefix $(srcdir)/,$(binding_built_sources))
 
 # Instruct GNU make to delete the targets of a rule after it failed, in
 # order to avoid the complication of handling that situation manually.