Codoc Directories¶

The codoc’s home directory¶

The codoc’s home directory is specified in the codocUser_[user_name].cdc file.

Here is the sequence to get it :

1. retrieve the user’s login, let’s say capt
2. read the codocUsers.lst and look for capt
3. read the users/codocUser_capt.cdc file
4. fetch the value of the key path, let’s say /home/capt/digicapt

The codoc’s working directory¶

The codoc’s working directory is in the codoc’s home directory. The directory path is stored in the codoc2.conf file, key codoc of the path section, let’s say codoc.

So in our case the complete codoc’s working directory is /home/capt/digicapt/codoc.

Structure¶

The codoc’s working directory contains two initial files called projects.lst and packages.lst, and a bunch of configuration whose name starts with project_ or package_.

The initial files just contain the exhaustive list of existing projects and packages. For each item in the lists, a file contains the configuration of the project, respectively the package.

The order of the entries in the list does matter, as it defines the compilation order of the packages.

Project configuration¶

The project configuration file is named project_[project_name].cdc.

It indicates the project’s name again, a short desription, the user who created it and the creation day. But the most useful information is the value of the key path. It indicates in the source directory where the project is stored.

Package configuration¶

The package configuration file is named package_[package_name].cdc.

The source directory¶

The source directory is in the codoc’s home directory. The directory path is stored in the codoc2.conf file, key source of the path section, let’s say sources.

So in our case the complete source directory is /home/capt/digicapt/sources.

Then each project is stored in that directory, based on the value of the key path of the project_[project_name].cdc file of the codoc’s working directory.

And the same way each package is stored in its project’s directory, based on the value of the key path of the package_[package_name].cdc file of the codoc’s working directory.

Then package directory contains then two sub-directories :

• src
• test

Summary of the directories :¶

• /home/capt/digicapt ← codoc user’s configuration
  • codoc ← codoc’s configuration
    • projects.lst
    • package.lst
    • project_bigProject.cdc
    • project_smallProject.cdc
    • package_myFirstPackage.cdc
    • package_mySecondPackage.cdc
    • package_myThirdPackage.cdc
  • sources ← codoc’s configuration
    • bigProject/subBigProject ← project_bigProject.cdc
      • myFirstPackage/subFirstPackage ← package_myFirstPackage.cdc
        • src
          • CMakeLists.txt
          • source1.cc
          • source1.hh
          • source2.cc
          • source2.hh
        • tst
          • testsource1.cc
          • testsource1.hh
          • testsource2.cc
          • testsource2.hh
      • mySecondPackage ← package_myFirstPackage.cdc
        • src
          • CMakeLists.txt
          • source1.cc
          • source1.hh
        • tst
          • testsource1.cc
          • testsource1.hh
    • smallProject ← projectsmallProject.cdc
      • myThirdPackage ← package_myFirstPackage.cdc
        • src
          • CMakeLists.txt
          • source1.cc
          • source1.hh
        • tst
          • testsource1.cc
          • testsource1.hh