Location of Essential Files

Learning the ins and outs of a new directory structure can be difficult, so here is some help on the location of key files. The paths use the Unix convention of forward slashes (/); Windows users should substitute back slashes (\). Links take you to help topics that present information about the directory structures graphically.

• Compiled libraries
  
  Assuming you are using standard CBM directory paths, compiled libraries are created in the lib directory of a Rogue Wave workspace. There is one workspace and corresponding lib directory for each build configuration for which libraries have been built. The build configuration results in the path <operating_system>/<compiler>/<build_type_code>. The path to Tools.h++ libraries compiled with Msvc under Windows NT with a build type code of 6d would be

  <rw_root>/workspaces/WINNT/MSVC/6d/lib

  You do, however, have the option of specifying alternative workspace locations anywhere on your system by use of the rwspm script's -w option.
  
  
• Header files
  
  Header files are exported to the Rogue Wave workspace. Tools.h++ header files are placed in the rw directory of the workspace. Header files for all other products are placed in a subdirectory of rw named for the product. So the location of the header files for Tools.h++ compiled with Msvc under Windows NT with a build type code of 6d would be

  <rw_root>/workspaces/WINNT/MSVC/6d/rw

  and the location of the header files for Threads.h++ compiled with the same parameters would be

  <rw_root>/workspaces/WINNT/MSVC/6d/rw/threads

  
  
• Makefiles
  
  The customized makefile (or makefiles) used to build a library is written to the <workspace>/buildloc/<part> directory or its subdirectories. The path for Tools.h++ compiled with Msvc and a build type of d7 under Windows NT would be

  <rw_root>/workspaces/WINNT/MSVC/d7/buildloc/tlsnnnnw/makefile

  Examples makefiles are exported to your declared workspace under <workspace>/examples/<part>. For the Tools.h++ case cited above, the default path would be
  
  <rw_root_dir>/workspaces/WINNT/MSVC/7d/examples/tlsnnnnw/makefile
  
  Note that some products divide the examples into subsets, which results in subdirectories of <workspace>/examples/<part>. In this case, there may be multiple makefiles in <workspace>/examples/<part> and in its subdirectories.
  
  
• Source files
  
  A library's implementation source files (.cpp) remain in the product tree, unless you choose, by specifying the -l flag of the rwspm script, to copy these files to <workspace>/buildloc/<part>. The path within the parts directory for Tools.h++ on a Unix platform would be

  <rw_root>/parts/tlsnnnnu/source/src/*.cpp

• Object files
  
  Like the makefile, the object files (.obj) created by a build are generated in the <workspace>/buildloc/<part> directory or its subdirectories. The path for Tools.h++ compiled with Msvc and a build type of d7 under Windows NT would be

  <rw_root>/workspaces/WINNT/MSVC/d7/buildloc/tlsnnnnw/*.obj

• Build scripts
  
  The build scripts used by CBM are stored in <spm_root>/scripts.
  
  
• Documentation
  
  The readme documentation for C++ libraries is in the docs directory of the library's product tree. All of the C++ product online documentation (user guides, references, and so on) is in the <rw_root_dir>/htmldocs directory.
  
  

  ---

  Rogue Wave strongly advises that you check the build guide for a library product before building it, particularly for products with dependencies on other products. The build guides are located in the htmldocs directory of the Rogue Wave root directory. The name follows the pattern <product+version>bd, as in tls708bd for Tools.h++.

  ---

CBM User Guide
Index