*** empty log message ***

2 files changed, 115 insertions, 23 deletions

diff --git a/ChangeLog b/ChangeLog
index da136519..9b7f2972 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,31 @@
 1998-05-21  Martin Baulig  <martin@home-of-linux.org>
 
+	* Makefile.am: 'gtopConf.sh' has been renamed to
+	'libgtopConf.sh'; variables in this script have changed.
+
+	* lib/Makefile.am: uses '@LIBGTOP_SERVER@' instead of
+	'@GTOP_SERVER@'.
+
+	* configure.in: renamed variables for 'libgtopConf.sh.in'.
+
+	* acconfig.h: added 'NEED_LIBGTOP'.
+
+	* libgtopConf.sh.in: renamed from 'gtopConf.sh.in';
+	we now define 'LIBGTOP_LIBDIR', 'LIBGTOP_INCLUDEDIR',
+	'LIBGTOP_LIBS', 'LIBGTOP_INCS', 'LIBGTOP_GUILE_LIBS',
+	'LIBGTOP_GUILE_INCS', 'LIBGTOP_BINDIR', 'LIBGTOP_SERVER',
+	'libgtop_sysdeps_dir', 'libgtop_need_server',
+	'libgtop_use_machine_h', 'libgtop_guile_found',
+	'libgtop_want_names', 'libgtop_want_guile_names',
+	'libgtop_want_examples'.
+	
+	* gtopConf.sh.in: renamed to 'libgtopConf.sh.in'.
+	
+	* acinclude.m4 (AC_LC_SYSDEPS): rewrote that macro -
+	moved some of the code to 'macros/gnome-libgtop-sysdeps.m4';
+	renamed variables: look at the ChangeLog entry for the
+	new 'libgtopConf.sh.in' for details.
+
 	* doc/gnome-hackers.sgml: added information about latest
 	changes in 'acinclude.m4' and 'gtopConf.sh.in'.
 
diff --git a/doc/gnome-hackers.sgml b/doc/gnome-hackers.sgml
index 6edbf6fa..a6f16855 100644
--- a/doc/gnome-hackers.sgml
+++ b/doc/gnome-hackers.sgml
@@ -1,7 +1,7 @@
 <!-- $Id$ -->
 
 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity gtopConf.sh SYSTEM "../gtopConf.sh" >
+<!entity libgtopConf.sh SYSTEM "../libgtopConf.sh" >
 ]>
 <book>
   <bookinfo>
@@ -57,7 +57,7 @@
 	<productname>libgtop</productname> in the GNOME project.
 	It describes the additional options <filename>configure</filename>
 	takes and the information stored in the automatically generated
-	<filename>gtopConf.sh</filename> configuration script.
+	<filename>libgtopConf.sh</filename> configuration script.
 
     </abstract>
 
@@ -65,6 +65,70 @@
 
   <toc></toc>
 
+  <chapter id="macros">
+    <title>Autoconf macros</title>
+
+    <sect1 id="gnome-libgtop-sysdeps">
+      <title><filename>macros/gnome-libgtop-sysdeps.m4</filename></title>
+
+      <para>
+	This file defines <function>GNOME_LIBGTOP_SYSDEPS</function> which you can
+	use to check which sysdeps directory <productname>libgtop</productname> should
+	use and whether the <filename>gtop_server</filename> is needed.
+
+      <para>
+	It defines the following variables:
+	
+	<variablelist>
+	      
+	  <varlistentry>
+	    <term><parameter>libgtop_sysdeps_dir</parameter>
+		  
+	    <listitem>
+	      <para>
+		The sysdeps dir <productname>libgtop</productname> uses.
+		    
+	  <varlistentry>
+	    <term><parameter>libgtop_use_machine_h</parameter></term>
+
+	    <listitem>
+	      <para>
+		Some of the system dependent parts of <productname>libgtop</productname>
+		provide a structure <structname>_glibtop_machine</structname> defined in
+		a header file <filename>glibtop_machine.h</filename> they provide. This
+		structure gets inserted into the <structfield>machine</structfield> member
+		of <structname>_glibtop</structname> when <filename>config.h</filename>
+		defines <parameter>HAVE_GLIBTOP_MACHINE_H</parameter>.
+
+	      <para>
+		This variable is either <literal>yes</literal> or <literal>no</literal> and
+		tells you whether this is the case. If it is true, this macro wil automatically
+		define <parameter>HAVE_GLIBTOP_MACHINE_H</parameter>.
+
+	  <varlistentry>
+	    <term><parameter>libgtop_need_server</parameter></term>
+
+	    <listitem>
+	      <para>
+		Is either <literal>yes</literal> or <literal>no</literal> and tells you
+		whether the server is needed. If it is needed, it will automatically
+		define <parameter>NEED_LIBGTOP</parameter>.
+
+	      <para>
+		This macro also provides a conditional <parameter>NEED_LIBGTOP</parameter>
+		which you can use in you <filename>Makefile.am</filename>.
+
+	</variablelist>
+
+    <sect1 id="gnome-libgtop-check">
+      <title><filename>macros/gnome-libgtop-check.m4</filename></title>
+
+      <para>
+	Checks whether <productname>libgtop</productname> can be found and includes everything
+	from its <filename>libgtopConf.sh</filename> configuration script.
+
+    </sect1>
+    
   <chapter id="configure">
     <title>Configuration</title>
 
@@ -81,7 +145,7 @@
 	    server is required. Depending upon this decision, it adds either
 	    <literal>-lgtop</literal> (when it's needed) or
 	    <literal>-lgtop_systems</literal> (when it's not needed) to
-	    <parameter>GTOP_LIBS</parameter> and <parameter>GTOP_GUILE_LIBS</parameter>.
+	    <parameter>LIBGTOP_LIBS</parameter> and <parameter>LIBGTOP_GUILE_LIBS</parameter>.
 
 	  <para>
 	    You can change this behaviour with the following options:
@@ -135,7 +199,6 @@
 	  <para>
 	    If you do not need the <filename>names</filename> subdirs, you can disable
 	    their building with the following option:
-	    when <productname>guile</productname> can be found on the system.
 
 	    <variablelist>
 	      
@@ -155,6 +218,9 @@
 		    
 	    </variablelist>
 
+	  <para>
+	    If it is enables, <parameter>GLIBTOP_NAMES</parameter> will be defined.
+
 	<listitem>
 
 	  <para>
@@ -173,12 +239,12 @@
 
       </itemizedlist>
     
-  <chapter id="gtopConf">
-    <title>The <filename>gtopConf.sh</filename> script</title>
+  <chapter id="libgtopConf">
+    <title>The <filename>libgtopConf.sh</filename> script</title>
 
     <para>
       After a successful build of <productname>libgtop</productname>, a
-      <filename>gtopConf.sh</filename> script is generated which will later
+      <filename>libgtopConf.sh</filename> script is generated which will later
       be used to decide how to link a program with <filename>libgtop</filename>.
 
     <para>
@@ -187,7 +253,7 @@
       <variablelist>
 	      
 	<varlistentry>
-	  <term><parameter>GTOP_LIBDIR</parameter>
+	  <term><parameter>LIBGTOP_LIBDIR</parameter>
 		  
 	  <listitem>
 	    <para>
@@ -195,7 +261,7 @@
 	      where the <productname>libgtop</productname> libraries get installed.
 
 	<varlistentry>
-	  <term><parameter>GTOP_INCLUDEDIR</parameter></term>
+	  <term><parameter>LIBGTOP_INCLUDEDIR</parameter></term>
 		
 	  <listitem>
 	    <para>
@@ -203,7 +269,7 @@
 	      where the <productname>libgtop</productname> header files get installed.
 
 	<varlistentry>
-	  <term><parameter>GTOP_LIBS</parameter></term>
+	  <term><parameter>LIBGTOP_LIBS</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -212,7 +278,7 @@
 	      <productname>libgtop</productname>.
 
 	<varlistentry>
-	  <term><parameter>GTOP_INCS</parameter></term>
+	  <term><parameter>LIBGTOP_INCS</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -221,7 +287,7 @@
 	      <productname>libgtop</productname>.
 
 	<varlistentry>
-	  <term><parameter>GTOP_GUILE_INCS</parameter></term>
+	  <term><parameter>LIBGTOP_GUILE_INCS</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -230,7 +296,7 @@
 	      <productname>libgtop</productname> and its guile interface.
 
 	<varlistentry>
-	  <term><parameter>GTOP_BINDIR</parameter></term>
+	  <term><parameter>LIBGTOP_BINDIR</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -238,7 +304,7 @@
 	      <productname>libgtop</productname> binaries get installed.
 
 	<varlistentry>
-	  <term><parameter>GTOP_SERVER</parameter></term>
+	  <term><parameter>LIBGTOP_SERVER</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -246,14 +312,14 @@
 	      where the server gets installed.
 
 	<varlistentry>
-	  <term><parameter>GTOP_SYSDEPS_DIR</parameter></term>
+	  <term><parameter>libgtop_sysdeps_dir</parameter></term>
 	  
 	  <listitem>
 	    <para>
 	      The sysdeps directory that is used on your system.
 
 	<varlistentry>
-	  <term><parameter>GTOP_NEED_SERVER</parameter></term>
+	  <term><parameter>libgtop_need_server</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -261,7 +327,7 @@
 	      whether using the server is needed or not.
 
 	<varlistentry>
-	  <term><parameter>GTOP_USE_MACHINE_H</parameter></term>
+	  <term><parameter>libgtop_use_machine_h</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -276,7 +342,7 @@
 	      <structname>_glibtop</structname>.
 
 	<varlistentry>
-	  <term><parameter>GTOP_GUILE_FOUND</parameter></term>
+	  <term><parameter>libgtop_guile_found</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -285,7 +351,7 @@
 	      (or if building the guile interface was disabled).
 
 	<varlistentry>
-	  <term><parameter>GTOP_WANT_NAMES</parameter></term>
+	  <term><parameter>libgtop_want_names</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -293,7 +359,7 @@
 	      whether the <filename>sysdeps/names</filename> subdirectory was build.
 
 	<varlistentry>
-	  <term><parameter>GTOP_WANT_GUILE_NAMES</parameter></term>
+	  <term><parameter>libgtop_want_guile_names</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -301,7 +367,7 @@
 	      whether the <filename>sysdeps/guile/names</filename> subdirectory was build.
 
 	<varlistentry>
-	  <term><parameter>GTOP_WANT_EXAMPLES</parameter></term>
+	  <term><parameter>libgtop_want_examples</parameter></term>
 	  
 	  <listitem>
 	    <para>
@@ -311,9 +377,9 @@
       </variablelist>
 
       <example>
-	<title>Sample <filename>gtopConf.sh</filename></title>
+	<title>Sample <filename>libgtopConf.sh</filename></title>
 
-	<programlisting>&gtopConf.sh;</programlisting>
+	<programlisting>&libgtopConf.sh;</programlisting>
       </example>