content/tools/build_env_modstruct.html

<html>
<head>
<title>OpenOffice.org - CVS Module Structure</title>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body>
<H2>CVS Module Structure</H2>

<P>
The following sections describe the general file structure of modules.
</P>

<UL>
<LI>
<A HREF="build_env_modstruct.html#3.4.1.TopLevelCVSModuleDirectoryStructure|outline">Top Level
CVS Module Directory Structure</A></LI>

<LI>
<A HREF="build_env_modstruct.html#3.4.2.CompiledObjectsor$INPATHDirectoryStructure|outline">Compiled
Objects or $INPATH Directory Structure</A></LI>
</ul>


<H3>
<a NAME="3.4.1.TopLevelCVSModuleDirectoryStructure|outline"></A>Top Level
Module Directory Structure</H3>

<P>
The following table lists the subdirectories of a typical module directory,
and describes the contents of those subdirectories. You can also view an
<A HREF="modules.gif">illustration</A> of the module directory
structure.
</P>

<table BORDER=0 CELLSPACING=0 CELLPADDING=0 >
<tr VALIGN=TOP>
<TH>Directory</TH>

<TH>Description</TH>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR>
</TD>

<TD>The root directory of the module.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/inc</CODE>
</TD>

<TD>Contains the header files and interface descriptions for the module.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/prj</CODE>
</TD>

<TD>Contains the file <CODE>d.lst</CODE>. This file lists all the deliverables
of the module. It details where the deliverables come from and where they
go to.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/source</CODE>
</TD>

<TD>Contains source files and a makefile to compile the source.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/util</CODE>
</TD>

<TD>Linking to binaries occurs here. This directory contains a makefile
that specifies how to build the module libraries or binaries.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/$INPATH</CODE>
</TD>

<TD>The name of this directory comes from the <CODE>INPATH</CODE> variable.
The <CODE>INPATH</CODE> variable derives from the <CODE>OUTPATH</CODE> and <CODE>PROEXT</CODE>
variables. For example, a directory called <VAR>module-name</VAR>/<CODE>unxlngi3.pro</CODE> 
may exist or will be created when starting to build this platform.
<P>All compiled objects, libraries, and binaries are built into this directory.
From there they are delivered to <CODE>solver</CODE>. For more information
on this directory, see 
<a href="3.4.2.CompiledObjectsor$INPATHDirectoryStructure|outline">Compiled
Objects or $INPATH Directory Structure</A>.</P></TD>

</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/common.pro</CODE>
</TD>

<TD>Contains platform-independent output, such as resource files, <CODE>.jar</CODE>
files, and <CODE>.zip</CODE> files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/res</CODE>
</TD>

<TD>Contains typical resource files such as bitmaps, icons, and cursor
files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/sdi</CODE>
</TD>

<TD>Contains View Definition Interface files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/unoidl</CODE>
</TD>

<TD>Contains the UNO IDL compiler for <CODE>.idl</CODE> files, supplied with
backends for C++, Java, documentation, and so on.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/workben</CODE>
</TD>

<TD>Contains test applications.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
</TD>

<TD></TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/mac</CODE>
</TD>

<TD>Contains implementation files specific to Macintosh.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/os2</CODE>
</TD>

<TD>Contains implementation files specific to OS/2.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/unx</CODE>
</TD>

<TD>Contains implementation files specific to X Windows System.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<VAR>module-name</VAR><CODE>/win</CODE>
</TD>

<TD>Contains implementation files specific to Win32.</TD>
</TR>
</table>

<H3>
<a NAME="3.4.2.CompiledObjectsor$INPATHDirectoryStructure|outline"></A>Compiled
Objects or $INPATH Directory Structure</H3>

<P>
The following table lists the subdirectories of a typical output directory, 
and describes the contents of those subdirectories.
</P>

<table BORDER=0 CELLSPACING=0 CELLPADDING=0 >

<tr VALIGN=TOP>
<TH>Directory</TH>

<TH>Description</TH>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>$INPATH</CODE>
</TD>

<TD>Root directory of the output structure.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>bin</CODE>
</TD>

<TD>Contains binary and files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>class</CODE>
</TD>

<TD>Contains Java-compiled class and/or jar files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>dbo</CODE>
</TD>

<TD>In the past, this directory contained debug information from the Writer
project only. It is obsolete now.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>dib</CODE>
</TD>

<TD></TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>dlb</CODE>
</TD>

<TD>In the past, this directory contained debug information from the Writer
project only. It is obsolete now.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>doc</CODE>
</TD>

<TD>Contains generated HTML.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>dso</CODE>
</TD>

<TD>In the past, this directory contained debug information from the Writer
project only. It is obsolete now.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>idl</CODE>
</TD>

<TD>Contains Interface definition Language (IDL) files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>inc</CODE>
</TD>

<TD>Contains project interface header files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>lib</CODE>
</TD>

<TD>Can contain the following files:
<UL>
<LI><CODE>.a</CODE> - Contains static UNIX libraries.</LI>
<LI><CODE>.so</CODE> - Contains shared UNIX libraries.</LI>
<LI><CODE>.lib</CODE> - On UNIX systems, contains a list of object files. 
On Win32 systems, contains a collection of object files.</LI>
<LI><CODE>.dump</CODE> - Contains the symbols within a library.</LI>
</UL>
</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>misc</CODE>
</TD>

<TD>Contains a record of some of the commands run by the make process.
This also contains the generated dependency description for this module.
Typically, tools such as <CODE>makedep</CODE>, <CODE>javadep</CODE>, or <CODE>rscdep</CODE>
generate this description. 
Also contains generated Java files, in a <CODE>java</CODE> subdirectory.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>obj</CODE>
</TD>

<TD>Contains object files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>res</CODE>
</TD>

<TD>Contains resource files. These are organized in subdirectories named
according to language codes. There are bitmaps in these subdirectories.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>slb</CODE>
</TD>

<TD>
Contains <CODE>.lib</CODE> files. These list the objects to be compiled into a 
shared library. On Win32 systems, the <CODE>.lib</CODE> files are a collection of objects.
</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>slo</CODE>
</TD>

<TD>The shared library object (<CODE>slo</CODE>) directory contains object
files that appear in shared libraries. Objects that appear in shared libraries
appear in both the <CODE>obj</CODE> and <CODE>slo</CODE> directories.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>srs</CODE>
</TD>

<TD>Contains string resource files.</TD>
</TR>

<tr VALIGN=TOP>
<TD>
<CODE>www</CODE>
</TD>

<TD>Contains files published on the internet.</TD>
</TR>
</table>
</body>
</html>