-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #209 from skliper/fix204-doxygen_frontpage
Fix #204, Doxygen frontpage refactor and cleanup
- Loading branch information
Showing
29 changed files
with
539 additions
and
3,129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,36 @@ | ||
core Flight System (cFS) CFDP Application (CF) | ||
====================================================== | ||
#core Flight System (cFS) CFDP Application (CF) | ||
|
||
Open Source Release Readme | ||
========================== | ||
## Introduction | ||
|
||
CF Release 3.0.0 | ||
The CFDP application (CF) is a core Flight System (cFS) application | ||
that is a plug in to the Core Flight Executive (cFE) component of the cFS. | ||
|
||
Date: 09/28/2021 | ||
CF is a cFS application for providing CFDP (CCSDS File Delivery Protocol) CCSDS 727.0-B-5 compliant | ||
services. Its primary function is to provide file receive and transmit | ||
functionality to this protocol. It works by mapping CFDP PDUs on and off cFS's | ||
software bus. | ||
|
||
Introduction | ||
------------- | ||
The CFDP application (CF) is a core Flight System (cFS) application | ||
that is a plug in to the Core Flight Executive (cFE) component of the cFS. | ||
The CF application is written in C and depends on the cFS Operating System | ||
Abstraction Layer (OSAL) and cFE components. There is additional CF application | ||
specific configuration information contained in the application user's guide. | ||
|
||
CF 3.0 is a cFS application for providing CFDP (CCSDS File Delivery Protocol) | ||
services. Its primary function is to provide file receive and transmit | ||
functionality to this protocol. It works by mapping CFDP PDUs on and off cFS's | ||
software bus. | ||
User's guide information can be generated using Doxygen (from top mission directory): | ||
``` | ||
make prep | ||
make -C build/docs/cf-usersguide cf-usersguide | ||
``` | ||
|
||
The CF application is written in C and depends on the cFS Operating System | ||
Abstraction Layer (OSAL) and cFE components. There is additional CF application | ||
specific configuration information contained in the application user's guide. | ||
|
||
Developer's guide information can be generated using Doxygen: | ||
doxygen cf_doxygen_config.txt | ||
## Software Required | ||
|
||
cFS Framework (cFE, OSAL, PSP) | ||
|
||
Software Included | ||
------------------ | ||
An integrated bundle including the cFE, OSAL, and PSP can | ||
be obtained at https://github.com/nasa/cfs | ||
|
||
CFDP application (CF) 3.0.0 | ||
## About cFS | ||
|
||
|
||
Software Required | ||
------------------ | ||
|
||
cFS Caelum | ||
|
||
Note: An integrated bundle including the cFE, OSAL, and PSP can | ||
be obtained at https://github.com/nasa/cfs | ||
|
||
About cFS | ||
---------- | ||
The cFS is a platform and project independent reusable software framework and | ||
set of reusable applications developed by NASA Goddard Space Flight Center. | ||
This framework is used as the basis for the flight software for satellite data | ||
systems and instruments, but can be used on other embedded systems. More | ||
information on the cFS can be found at http://cfs.gsfc.nasa.gov | ||
|
||
EOF | ||
The cFS is a platform and project independent reusable software framework and | ||
set of reusable applications developed by NASA Goddard Space Flight Center. | ||
This framework is used as the basis for the flight software for satellite data | ||
systems and instruments, but can be used on other embedded systems. More | ||
information on the cFS can be found at http://cfs.gsfc.nasa.gov |
Oops, something went wrong.