Skip to content

Commit 4927ed9

Browse files
committed
Fix #2413, Update Dev Guide to fix out-of-date references and broken
links
1 parent 0316672 commit 4927ed9

35 files changed

+302
-317
lines changed

docs/README_functionaltest.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ This must be the first library loaded for any functional test.
1919
- `cfe_testcase`: a CFE-compatible library implementing test cases for CFE core apps.
2020
This must be loaded after `cfe_assert`.
2121

22-
- `cfe_testrunner`: a CFE application that actually executes the tests. This is a very
23-
simple app that waits for CFE startup to complete, then executes all registered test
24-
cases. It also must be loaded after `cfe_assert`.
25-
2622

2723
## Example startup script entries
2824

docs/cFE Application Developers Guide.md

Lines changed: 229 additions & 240 deletions
Large diffs are not rendered by default.

docs/src/cfe_evs.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163
\ref cfeevsugmsgfilter (only the Binary Filtering Scheme
164164
exists currently). Note that applications are limited in the number of events that
165165
they can register for filtering (see #CFE_PLATFORM_EVS_MAX_EVENT_FILTERS in cfe_platform_cfg.h
166-
for the mission defined limit). The filtering method uses a mask to determine if the
166+
for the mission-defined limit). The filtering method uses a mask to determine if the
167167
message is forwarded to the software bus, making it available in telemetry (see
168168
\ref cfeevsugmsgfilter for a description on filtering). Commands are available to
169169
\link #CFE_EVS_SET_FILTER_CC modify the filter mask \endlink for any registered event.

docs/src/cfe_frontpage.dox

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,10 @@
106106

107107
\section cfebackground_s1 Core Flight Executive (cFE) Goals
108108

109-
The main long term goal of the cFE is to form the basis for a platform and project
109+
The main long-term goal of the cFE is to form the basis for a platform and project
110110
independent reusable software framework. The cFE with the OSAL allow the development
111111
of portable embedded system software that is independent of a particular Real Time
112-
Operating System and hardware platform. A secondary long term goal is to create a
112+
Operating System and hardware platform. A secondary long-term goal is to create a
113113
standardized, product-line approach for development of embedded aerospace flight
114114
software. <BR>
115115

@@ -121,7 +121,7 @@
121121
promoting the growth of the application and library layers where new applications, libraries,
122122
tools, and lessons learned can be contributed and shared. <BR>
123123

124-
It is important for application developers to realize the long term and functional
124+
It is important for application developers to realize the long-term and functional
125125
goals of the cFE. With a standard set of services providing a standard API, all
126126
applications developed with the cFE have an opportunity to become useful on
127127
future missions through code reuse. In order to achieve this goal,

docs/src/cfe_glossary.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
cFE following a Processor Reset.
4545
<TR>
4646
<TD> \anchor cfeadg_crc Cyclic Redundancy Check
47-
<TD> A polynomial based method for checking that a data set
47+
<TD> A polynomial-based method for checking that a data set
4848
has remained unchanged from one time period to another.
4949
<TR>
5050
<TD> \anchor cfeadg_developer Developer

docs/src/cfe_tbl.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
The default table type for a cFE Application to use is a single buffered table. The principle
117117
advantage of a single buffered table is that it can share one of several shared table buffers
118118
for uploaded and pending table images. Since many cFE Applications have relatively small tables
119-
that are not changed at time critical moments or are not changed very often during a mission,
119+
that are not changed at time-critical moments or are not changed very often during a mission,
120120
single buffered tables represent the most memory resource efficient method of being managed.
121121

122122
The number of single buffered tables that can have inactive table images being manipulated at one

docs/src/cfe_time.dox

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
easily be manipulated and utilized. These components include:
6969

7070
The <B>Ground Epoch</B> is an arbitrary date and time that establishes the zero point
71-
for spacecraft time calculations. The selection of the epoch is mission specific,
71+
for spacecraft time calculations. The selection of the epoch is mission-specific,
7272
although in the past, it was common to select the same epoch as defined for the
7373
Operating System used by the computers hosting the ground system software. Recent
7474
mission epoch selections have also included using zero seconds after midnight,
@@ -247,7 +247,7 @@
247247
#define CFE_MISSION_TIME_CFG_DEFAULT_UTC TRUE
248248
\endverbatim
249249

250-
The choice of time format is a mission specific decision and is not directly
250+
The choice of time format is a mission-specific decision and is not directly
251251
affected by the hardware configuration.
252252

253253
\sa #CFE_MISSION_TIME_CFG_DEFAULT_TAI, #CFE_MISSION_TIME_CFG_DEFAULT_UTC <BR>
@@ -659,7 +659,7 @@
659659
to the current STCF. In addition there is a 1Hz adjustment
660660
(#CFE_TIME_ADD_1HZ_ADJUSTMENT_CC and #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC)
661661
that can be made to the STCF to compensate for oscillator drift.
662-
Mission specific ground correlation should be used to assist in
662+
Mission-specific ground correlation should be used to assist in
663663
determining the proper values to use. The Leap Seconds should be
664664
set to the current TAI-UTC. Note that the International Earth
665665
Rotation and Reference Systems Service Bulletin C, which defines

docs/src/mnem_maps/cfe_es_cmd_mnem_map

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#---------------------------------------------------------------------------
22
# Each of the following assignment statements should have the documentation
3-
# mnemonic on the left followed by the mission specific command mnemonic
3+
# mnemonic on the left followed by the mission-specific command mnemonic
44
# on the right of the equals operator.
55
#
66
# FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_es_tlm_mnem_map

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#---------------------------------------------------------------------------
22
# Each of the following assignment statements should have the documentation
3-
# mnemonic on the left followed by the mission specific telemetry mnemonic
3+
# mnemonic on the left followed by the mission-specific telemetry mnemonic
44
# on the right of the equals operator.
55
#
66
# FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_evs_cmd_mnem_map

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#---------------------------------------------------------------------------
22
# Each of the following assignment statements should have the documentation
3-
# mnemonic on the left followed by the mission specific command mnemonic
3+
# mnemonic on the left followed by the mission-specific command mnemonic
44
# on the right of the equals operator.
55
#
66
# FORMATTING DETAILS TO REMEMBER!

0 commit comments

Comments
 (0)