diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md index 324a2189e..6d7847ce1 100644 --- a/docs/cFE Application Developers Guide.md +++ b/docs/cFE Application Developers Guide.md @@ -303,16 +303,138 @@ a variation on this standard. ## 2.1 Directory Tree -The following diagrams show the standard development and build directory +The following shows the standard development and build directory tree or mission tree as it is often referred to. The purpose of each directory is described as a note under each folder. -![](.//media/cFE_Application_Developers_Guide_image4.png) - -![](.//media/cFE_Application_Developers_Guide_image5.png) - -![](.//media/cFE_Application_Developers_Guide_image6.png) - +-- missionxyz + |-- cfe + | |-- Contains a copy of the cFE component + |-- osal + | |-- Contains a copy of the OSAL component + |-- psp + | |-- Contains the Platform Suport Package (PSP) library. + | |-- Can customize PSP implementation for each CPU and OS that the project needs. + |-- build + | |-- The flight software is all configured and built under this directory. + | |-- All mission and platform configuration files are placed here. + |-- apps + | |-- Contains application source code. + | |-- Application source code may be shared amoung multiple build CPUs. + +-- missionxyz/cfe + |-- cmake + | |-- sample_defs + | |-- target + | |-- inc + | |-- src + |-- docs + |-- modules + |-- cfe_assert + | |-- inc + | |-- src + |-- cfe_testcase + | |-- src + |-- core_api + | |-- eds + | |-- fsw + | | |-- inc + | |-- ut-stubs + | |-- src + |-- core_private + | |-- eds + | |-- fsw + | | |-- inc + | |-- ut-stubs + | |-- inc + | |-- src + |-- es + | |-- eds + | |-- fsw + | | |-- inc + | | |-- src + | |-- ut-coverage + |-- evs + | |-- eds + | |-- fsw + | | |-- inc + | | |-- src + | |-- ut-coverage + |-- fs + | |-- fsw + | | |-- src + | |-- ut-coverage + |-- msg + | |-- fsw + | | |-- inc + | | |-- src + | |-- option_inc + | |-- ut-coverage + |-- resourceid + | |-- fsw + | | |-- inc + | | |-- src + | |-- option_inc + | |-- ut-coverage + |-- sb + | |-- eds + | |-- fsw + | | |-- inc + | | |-- src + | |-- ut-coverage + |-- sbr + | |-- fsw + | | |-- src + | |-- ut-coverage + |-- tbl + | |-- eds + | |-- fsw + | | |-- inc + | | |-- src + | |-- ut-coverage + |-- time + |-- eds + |-- fsw + | |-- inc + | |-- src + |-- ut-coverage + +-- missionxyz/build + |-- CMakeFiles + |-- cpu1 + | |-- default_cpu1 + | |-- CMakeFiles + | |-- apps + | |-- core_api + | |-- core_private + | |-- cpu1 + | |-- es + | |-- evs + | |-- fs + | |-- inc + | |-- msg + | |-- osal + | |-- psp + | |-- resourceid + | |-- sb + | |-- sbr + | |-- tbl + | |-- time + |-- cpuN + |-- docs + |-- exe + |-- inc + |-- src + |-- tools + + +-- missionxyz/apps + |-- ci_lab + |-- sample_app + |-- sample_lib + |-- sch_lab + |-- to_lab + Each cFE core component is itself a modular entity, all of which work together to form the complete cFE core executive. These modules are all contained under the `modules` subdirectory: @@ -343,15 +465,7 @@ Each module directory is in turn divided into subdirectories as follows: | _module_`/ut-coverage/` | Coverage tests to provide line/branch testing (correlates with internal implementation in `fsw/src`) | | _module_`/eds/` | Command & Telemetry interface description as a CCSDS book 876.0 Electronic Data Sheet | -![](.//media/cFE_Application_Developers_Guide_image7.png) - -![](.//media/cFE_Application_Developers_Guide_image8.png) - -![](.//media/cFE_Application_Developers_Guide_image9.png) - -![](.//media/cFE_Application_Developers_Guide_image10.png) -![](.//media/cFE_Application_Developers_Guide_image11.png) ## 2.2 Header Files