summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1997-12-17 00:36:36 +0000
committercoryan <coryan@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1997-12-17 00:36:36 +0000
commit06ff07d61a19167557db793432a720b9ec3793fb (patch)
treef25e0d3ea081b6cad00bd1cc7179e0c09333035a
parentbceee170d506cadfde2942d98a42b7a277024474 (diff)
downloadATCD-06ff07d61a19167557db793432a720b9ec3793fb.tar.gz
ChangeLogTag:Tue Dec 16 18:29:42 1997 Carlos O'Ryan <coryan@macarena.cs.wustl.edu>
-rw-r--r--TAO/ChangeLog-98c7
-rw-r--r--TAO/docs/orbsvcs.html56
-rw-r--r--TAO/orbsvcs/README1
3 files changed, 64 insertions, 0 deletions
diff --git a/TAO/ChangeLog-98c b/TAO/ChangeLog-98c
index e20a481641d..6d2b7c215a3 100644
--- a/TAO/ChangeLog-98c
+++ b/TAO/ChangeLog-98c
@@ -1,3 +1,10 @@
+Tue Dec 16 18:29:42 1997 Carlos O'Ryan <coryan@macarena.cs.wustl.edu>
+
+ * orbsvcs/README:
+ * docs/orbsvcs.html:
+ Started up the documentation for TAO services, at this point
+ only the directory hierarchy is explained.
+
Tue Dec 16 08:49:11 1997 Aniruddha Gokhale <gokhale@mambo.cs.wustl.edu>
* TAO_IDL/be_include/be_codegen.h: Added three more states for
diff --git a/TAO/docs/orbsvcs.html b/TAO/docs/orbsvcs.html
new file mode 100644
index 00000000000..85faa43277a
--- /dev/null
+++ b/TAO/docs/orbsvcs.html
@@ -0,0 +1,56 @@
+<html>
+ <!-- $Id$ -->
+ <head>
+ <title>TAO Services Documentation</title>
+ </head>
+
+ <body>
+ <H1>TAO Services Directory Hierarchy</H1>
+
+ <P>The file and directory organization for TAO services can be
+ confusing at first glance (and even on subsequent ones to be
+ honest),
+ so we felt like some rationale and explanation of the directory
+ hierarchy was needed.</P>
+
+ <P>For general sanity all TAO services files are located under
+ <CODE>$TAO_ROOT/orbsvcs</CODE>.
+ The current structure for this directory emphasizes the
+ decoupling from the interfaces (stubs) and their
+ implementation;
+ for this reason the services implementations are each on a
+ separate directory,
+ for instance <B>Naming Service</B> is in
+ <CODE>$TAO_ROOT/orbsvcs/Naming_Service</CODE>.</P>
+
+ <P>It is expected that clients use more
+ than one service at the same time
+ (in fact some of the services already do, for instance the
+ <B>Event Service</B> uses the <B>Naming Service</B> and the
+ <B>Scheduling Service</B>);
+ for this reason all the services stubs are grouped in one
+ library;
+ this library is located in
+ <CODE>$TAO_ROOT/orbsvcs/orbsvcs</CODE>.
+ Usually the include path is only <CODE>$TAO_ROOT/orbsvcs</CODE>,
+ so files are included like in:</P>
+
+<P><CODE>
+#include "orbsvcs/CosNamingC.h"
+</CODE></P>
+
+ <P>To simplify the IDL generation the skeletons are also on the
+ library,
+ this is not a problem for client programs and most services need
+ to link the library anyway
+ (since they use other services.)</P>
+
+ <P>Finally some test are located in
+ <CODE>$TAO_ROOT/orbsvcs/tests</CODE>,
+ since most tests require several files each one has its own
+ directory.</P>
+
+ <hr>
+ <address><a href="mailto:coryan@macarena.cs.wustl.edu">Carlos O'Ryan</a></address>
+ </body>
+</html>
diff --git a/TAO/orbsvcs/README b/TAO/orbsvcs/README
new file mode 100644
index 00000000000..bffd4dbd907
--- /dev/null
+++ b/TAO/orbsvcs/README
@@ -0,0 +1 @@
+Further documentation can be found in ../docs/orbsvcs.html