Skip to content

Commit

Permalink
Merge pull request nasa#382 from zacharysarah/issue-332
Browse files Browse the repository at this point in the history
Documentation updates for issue 332
  • Loading branch information
LeStarch authored Feb 20, 2021
2 parents 652eb08 + 2fbe530 commit 5d631af
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
17 changes: 12 additions & 5 deletions docs/Tutorials/MathComponent/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -1428,13 +1428,19 @@ Next, the test checks for the expected telemetry and events:

The other test cases are similarly implemented for the other operations. See the tutorial code for their implementation.

To build the unit test, type:
You must first generate the unit test before you can build it. Enter:

```
fprime-util generate --ut
```

Once you generate the unit test, you can build the unit test by entering:

```
fprime-util build --ut
```

The unit test can be run by typing the following in the `MathSender` (not `test/ut`) directory:
You can run the unit test by typing the following in the `MathSender` (not `test/ut`) directory:

```shell
$ fprime-util check
Expand Down Expand Up @@ -1899,7 +1905,8 @@ The component XML definitions must be imported into the topology file:
`Ref/Top/RefTopologyAppAi.xml`, line 32:
```xml
<import_component_type>Svc/PassiveTextLogger/PassiveTextLoggerComponentAi.xml</import_component_type>
<import_component_type>Svc/PassiveConsoleTextLogger/PassiveTextLoggerComponentAi.xml</import_component_type>
<import_component_type>Ref/MathSender/MathSenderComponentAi.xml</import_component_type>
<import_component_type>Ref/MathReceiver/MathReceiverComponentAi.xml</import_component_type>
Expand Down Expand Up @@ -2112,15 +2119,15 @@ The final connection is the connection that performs the math operation. It goes
```
Once all the updates to the topology file have been made, the module can be built by typing `fprime-util build` at the command line in the `Ref/Top` directory.
Once all the updates to the topology file have been made, the module can be built by typing `fprime-util build` at the command line in the `Ref/` directory.
If the updates were correct, the module should compile with no errors.
The overall `Ref` deployment can be built by changing to the `Ref` directory and typing `fprime-util build`.
If running on a different platform, you can specify the build target by typing `fprime-util generate <target>`.
## 4.1 Running the Ground System
Once the `Ref` example has successfully built, the ground system and executable can be run by typing `fprime-gds -d fprime/Ref`. The ground system GUI should appear:
Once the `Ref` example has built successfully, you can run the ground system and executable by entering `cd fprime/Ref; fprime-gds`. The ground system GUI should appear.
### 4.1.1 Executing Commands
Expand Down
2 changes: 1 addition & 1 deletion docs/UsersGuide/user/port-comp-top.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ represent the data being conveyed across the port.

A port supports passing arguments across the port's connection in order to pass data to the receiving
**Component** of an invocation. Some ports may also return data from the receiving **Component** to the invoking
**Component**. A port may specify zero or more arguments of any D´ data type or primitive (int, float, U8, etc.).
**Component**. A port may specify zero or more arguments of any F´ data type or primitive (int, float, U8, etc.).
Pointers and references are allowed as arguments to the port as well (for performance purposes), but care should be
taken to ensure correct memory management as the ownership of the underlying memory is effectively shared when the
port is invoked. The port's type is synonymous with the port invocations' "data_type" when used on a **Component**.
Expand Down

0 comments on commit 5d631af

Please sign in to comment.