SPFE Documentation | Collections > SPFE Development > Build directory structure

Build directory structure

The build systems produces a directory structure inside the build directory. Understanding the build directory structure can help you debug problems with the build.

By default, the build directory is named spfebuild and is created in the user's home directory. You can change the location of the build directory by setting the environment variable SPFE_BUILD_DIR.

The build script creates a directory for the content set being built, which is named using the content set id (configured in /content-set/content-set-id). Inside this directory it creates a directory named config which contains the consolidated configuration file, with the name spfe-config.xml.

The build then creates two additional directories in the content set directory, build, where all the temporary files used by the build are created, and output, where the output is created.

Inside the build directory, there are three directories, catalogs, where the link catalogs are created, topic-sets, where the each stage of the topic set build is created, and tocs, where the temporary TOC files are created. The link catalogs and temporary TOCs are located outside of the topic set directories because they are used by all topic set builds.

Inside the topic-sets directory, a directory is created for each topic set in the build, with its name matching the topic-set-id of each topic set.

Inside each of these topic set directories, the following files and directories are created:

• A build flag for each stage of the build. The build flag is used by the build for dependency checking purposes.

• A directory named after each step in the build process (extract, merge, resolve, presentation, etc.). Each directory contains the generated scripts for that step and an out directory that hold the result of the step (except for the steps that produce the final output, where the output goes to the content set output directory.

• The image-list.txt file, which is used to copy image files used in the topic set to the output directory.