GNOME.org
 

Re: .PHONY in Bonobo docs build

On Feb 12, 2001, "John R. Sheets" <dusk ravendusk org> wrote:
> 
> Hi,
> 
> I was just wondering why the html directory is included in the list of
> .PHONY targets in bonobo/doc/api/Makefile.am.  Only non-file targets
> are supposed to be used in .PHONY, IIRC.
> 
> The following patch fixes .PHONY and old references to the (no longer
> existent) bonobo-api-doc.sgml file.

Here's a much better version of this patch that also fixes a few
issues elsewhere in the API docs build.  This should remove the
remaining warnings from gtkdoc and improve the dependencies.  However,
I'm not 100% sure about the sanity of my changes to the Makefile.am,
so they should be reviewed before committing.

2001-02-12  John R. Sheets  <dusk ravendusk org>

            * doc/api/bonobo-api.sgml: Minor capitalization tweaks to title
            text.

            * doc/api/bonobo-decl.txt: Added missing declarations for
            BonoboItemHandlerEnumObjectsFn and BonoboItemHandlerGetObjectFn.

            * doc/api/bonobo-sections.txt: Removed orphaned <FILE> and
            <SECTION> tags, and errant PortableServer_Servant function decl in
            BonoboTransient.

            * doc/api/tmpl/bonobo-transient.sgml: Converted some &'s to &amp;

            * doc/api/Makefile.am: Remove (real, existing) html and sgml
            targets from .PHONY and change bonobo-api-doc.bottom to current
            bonobo-doc.bottom.
            (tmpl_sources): Add list of files in tmpl (formerly blank).

John

-- 
dusk ravendusk org                            http://www.gnome.org
jsheets codeweavers com                  http://www.worldforge.org
jsheets users sourceforge net     http://openbooks.sourceforge.net
               http://advogato.org/person/jsheets

                   Writing Gnome Applications
          http://www.aw.com/cseng/titles/0-201-65791-0/

Index: ChangeLog
===================================================================
RCS file: /cvs/gnome/bonobo/ChangeLog,v
retrieving revision 1.956
diff -u -r1.956 ChangeLog
--- ChangeLog	2001/02/09 18:10:41	1.956
+++ ChangeLog	2001/02/12 23:08:18
@@ -1,3 +1,22 @@
+2001-02-12  John R. Sheets  <dusk ravendusk org>
+
+	* doc/api/bonobo-api.sgml: Minor capitalization tweaks to title
+	text.
+
+	* doc/api/bonobo-decl.txt: Added missing declarations for
+	BonoboItemHandlerEnumObjectsFn and BonoboItemHandlerGetObjectFn.
+
+	* doc/api/bonobo-sections.txt: Removed orphaned <FILE> and
+	<SECTION> tags, and errant PortableServer_Servant function decl in
+	BonoboTransient.
+
+	* doc/api/tmpl/bonobo-transient.sgml: Converted some &'s to &amp;
+
+	* doc/api/Makefile.am: Remove (real, existing) html and sgml
+	targets from .PHONY and change bonobo-api-doc.bottom to current
+	bonobo-doc.bottom.
+	(tmpl_sources): Add list of files in tmpl (formerly blank).
+
 2001-02-09  Cody Russell  <bratsche gnome org>
 	* bonobo/bonobo-ui-engine-config.c: Remove the Cancel button.
 	Since this dialog makes changes in real time, this button serves
Index: doc/api/bonobo-api.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/bonobo-api.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-api.sgml
--- doc/api/bonobo-api.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/bonobo-api.sgml	2001/02/12 23:08:19
@@ -72,16 +72,16 @@
   </bookinfo>
 
   <chapter id="bonobo-core">
-    <title>Core Bonobo.</title>
+    <title>Core Bonobo</title>
     
       <sect1 id="bonobo-core-object">
-        <title>Core Bonobo Object</title>
+        <title>Core Bonobo Objects</title>
           &bonobo-object;
           &bonobo-main;
       </sect1>
 
       <sect1 id="bonobo-object-activation">
-        <title>Object activation, lyfecicle</title>
+        <title>Object Activation and Lifecycle</title>
           &bonobo-context;
           &bonobo-activation-context;
           &bonobo-moniker-util;
@@ -92,7 +92,7 @@
       </sect1>
 
       <sect1 id="bonobo-properties">
-        <title>Propeties</title>
+        <title>Properties</title>
   	  &bonobo-property-bag;
   	  &bonobo-property;
   	  &bonobo-property-types;
@@ -104,7 +104,7 @@
       </sect1>
 
       <sect1 id="bonobo-notification">
-        <title>Notification, EventSources</title>
+        <title>Notification and EventSources</title>
           &bonobo-event-source;
           &bonobo-listener;
       </sect1>
@@ -112,7 +112,7 @@
 
 
   <chapter id="bonobo-storage">
-    <title>Storage and persistance.</title>
+    <title>Storage and Persistance</title>
       &bonobo-storage;
       &bonobo-stream;
       &bonobo-stream-memory;
@@ -127,7 +127,7 @@
   </chapter>
 
   <chapter id="bonobo-documents-widgets">
-    <title>Bonobo Documents and Controls </title>
+    <title>Bonobo Documents and Controls</title>
       <sect1 id="bonobo-embedding">
         <title>Document interfaces</title>
           &bonobo-client-site;
@@ -172,13 +172,13 @@
   </chapter>
 
   <chapter id="bonobo-moniker-handlers">
-    <title>Writing monikers</title>
+    <title>Writing Monikers</title>
       &bonobo-moniker;
       &bonobo-item-handler;
   </chapter>
 
   <chapter id="bonobo-support-utilities">
-    <title>Supporting classes</title>
+    <title>Supporting Classes</title>
       &bonobo-plug;
       &bonobo-socket;
       &bonobo-wrapper;
@@ -186,6 +186,3 @@
       &bonobo-selector;
   </chapter>
 </book>
-
-
-
Index: doc/api/bonobo-decl.txt
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/bonobo-decl.txt,v
retrieving revision 1.5
diff -u -r1.5 bonobo-decl.txt
--- doc/api/bonobo-decl.txt	2000/12/04 07:21:34	1.5
+++ doc/api/bonobo-decl.txt	2001/02/12 23:08:51
@@ -1182,6 +1182,17 @@
 <STRUCT>
 <NAME>BonoboItemHandler</NAME>
 </STRUCT>
+<USER_FUNCTION>
+<NAME>BonoboItemHandlerEnumObjectsFn</NAME>
+<RETURNS>Bonobo_ItemContainer_ObjectNames </RETURNS>
+BonoboItemHandler *h, gpointer data, CORBA_Environment *ev
+</USER_FUNCTION>
+<USER_FUNCTION>
+<NAME>BonoboItemHandlerGetObjectFn</NAME>
+<RETURNS>Bonobo_Unknown </RETURNS>
+BonoboItemHandler *h, const char *item_name, gboolean only_if_exists,
+gpointer data, CORBA_Environment *ev
+</USER_FUNCTION>
 <STRUCT>
 <NAME>BonoboItemHandler</NAME>
 struct BonoboItemHandler {
Index: doc/api/bonobo-sections.txt
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/bonobo-sections.txt,v
retrieving revision 1.7
diff -u -r1.7 bonobo-sections.txt
--- doc/api/bonobo-sections.txt	2000/12/04 07:21:34	1.7
+++ doc/api/bonobo-sections.txt	2001/02/12 23:08:57
@@ -671,8 +671,6 @@
 </SECTION>
 
 <SECTION>
-<FILE>
-<SECTION>
 <FILE>bonobo-property</FILE>
 bonobo_property_servant_new
 bonobo_property_servant_destroy
@@ -787,7 +785,6 @@
 BONOBO_IS_TRANSIENT_CLASS
 BonoboTransient
 BonoboTransientClass
-PortableServer_Servant
 BonoboTransientServantNew
 BonoboTransientServantDestroy
 bonobo_transient_new
Index: doc/api/Makefile.am
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/Makefile.am,v
retrieving revision 1.8
diff -u -r1.8 Makefile.am
--- doc/api/Makefile.am	2000/12/04 07:21:34	1.8
+++ doc/api/Makefile.am	2001/02/12 23:08:59
@@ -14,8 +14,73 @@
 
 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
 
-tmpl_sources =
+tmpl_sources = 					\
+        tmpl/bonobo-activation-context.sgml	\
+        tmpl/bonobo-arg.sgml			\
+        tmpl/bonobo-canvas-component.sgml	\
+        tmpl/bonobo-canvas-item.sgml		\
+        tmpl/bonobo-client-site.sgml		\
+        tmpl/bonobo-component-io.sgml		\
+        tmpl/bonobo-context.sgml		\
+        tmpl/bonobo-control-frame.sgml		\
+        tmpl/bonobo-control.sgml		\
+        tmpl/bonobo-desktop-window.sgml		\
+        tmpl/bonobo-embeddable.sgml		\
+        tmpl/bonobo-event-source.sgml		\
+        tmpl/bonobo-exception.sgml		\
+        tmpl/bonobo-generic-factory.sgml	\
+        tmpl/bonobo-item-container.sgml		\
+        tmpl/bonobo-item-handler.sgml		\
+        tmpl/bonobo-listener.sgml		\
+        tmpl/bonobo-main.sgml			\
+        tmpl/bonobo-moniker-async.sgml		\
+        tmpl/bonobo-moniker-util.sgml		\
+        tmpl/bonobo-moniker.sgml		\
+        tmpl/bonobo-object-client.sgml		\
+        tmpl/bonobo-object-directory.sgml	\
+        tmpl/bonobo-object-io.sgml		\
+        tmpl/bonobo-object.sgml			\
+        tmpl/bonobo-persist-file.sgml		\
+        tmpl/bonobo-persist-stream.sgml		\
+        tmpl/bonobo-persist.sgml		\
+        tmpl/bonobo-plug.sgml			\
+        tmpl/bonobo-print-client.sgml		\
+        tmpl/bonobo-print.sgml			\
+        tmpl/bonobo-progressive.sgml		\
+        tmpl/bonobo-property-bag-client.sgml	\
+        tmpl/bonobo-property-bag-xml.sgml	\
+        tmpl/bonobo-property-bag.sgml		\
+        tmpl/bonobo-property-control.sgml	\
+        tmpl/bonobo-property-listener.sgml	\
+        tmpl/bonobo-property-types.sgml		\
+        tmpl/bonobo-property.sgml		\
+        tmpl/bonobo-selector.sgml		\
+        tmpl/bonobo-socket.sgml			\
+        tmpl/bonobo-storage-plugin.sgml		\
+        tmpl/bonobo-storage.sgml		\
+        tmpl/bonobo-stream-client.sgml		\
+        tmpl/bonobo-stream-memory.sgml		\
+        tmpl/bonobo-stream.sgml			\
+        tmpl/bonobo-transient.sgml		\
+        tmpl/bonobo-ui-component.sgml		\
+        tmpl/bonobo-ui-container.sgml		\
+        tmpl/bonobo-ui-node.sgml		\
+        tmpl/bonobo-ui-toolbar-button-item.sgml	\
+        tmpl/bonobo-ui-toolbar-icon.sgml	\
+        tmpl/bonobo-ui-toolbar-item.sgml	\
+        tmpl/bonobo-ui-toolbar-toggle-button-item.sgml \
+        tmpl/bonobo-ui-util.sgml		\
+        tmpl/bonobo-ui-xml.sgml			\
+        tmpl/bonobo-unused.sgml			\
+        tmpl/bonobo-view-frame.sgml		\
+        tmpl/bonobo-view.sgml			\
+        tmpl/bonobo-widget.sgml			\
+        tmpl/bonobo-win.sgml			\
+        tmpl/bonobo-wrapper.sgml		\
+        tmpl/bonobo-zoomable-frame.sgml		\
+        tmpl/bonobo-zoomable.sgml
 
+
 bonobo_docdir = $(HTML_DIR)
 bonobo_doc_DATA = \
 	bonobo-api.sgml		\
@@ -35,10 +100,10 @@
 bonobo-api.html:
 endif
 
-html/book1.html: sgml/bonobo-api-doc.bottom
+html/book1.html: sgml/bonobo-doc.bottom
 	$(MAKE) html
 
-sgml/bonobo-api-doc.bottom: $(tmpl_sources)
+sgml/bonobo-doc.bottom: $(tmpl_sources)
 	$(MAKE) sgml
 
 scan:
@@ -112,11 +177,11 @@
 templates: scan
 	cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 
-sgml:
+sgml: $(tmpl_sources) bonobo-sections.txt bonobo-decl.txt
 	cd $(srcdir) \
 	&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=..
 
-html:
+html: sgml
 	test -d $(srcdir)/html || mkdir $(srcdir)/html
 	-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 
@@ -151,5 +216,5 @@
 	-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 	-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
 
-.PHONY : html sgml templates scan
+.PHONY : templates scan
 
Index: doc/api/tmpl/bonobo-transient.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-transient.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-transient.sgml
--- doc/api/tmpl/bonobo-transient.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-transient.sgml	2001/02/12 23:09:01
@@ -107,7 +107,7 @@
         servant = g_new0 (MyServant, 1);
         servant->vepv = my_servant_get_epv ();
         servant->my_data = g_strdup ("Hello world!");
-        POA_My_Iface__init ((PortableServer_Servant) servant, &ev);
+        POA_My_Iface__init ((PortableServer_Servant) servant, &amp;ev);
         return servant;
 }
 
@@ -117,9 +117,9 @@
         CORBA_Environment ev;
 
         g_free (servant->my_data);
-        CORBA_exception_init (&ev);
-        POA_My_Iface__fini (servant, &ev);
-        CORBA_exception_free (&ev);
+        CORBA_exception_init (&amp;ev);
+        POA_My_Iface__fini (servant, &amp;ev);
+        CORBA_exception_free (&amp;ev);
 }
 
 CORBA_Object
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]