Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates for issue 332 #382

Merged
merged 6 commits into from
Feb 20, 2021
Merged

Conversation

zacharysarah
Copy link

@zacharysarah zacharysarah commented Feb 19, 2021

Originating Project/Creator
Affected Component Docs
Affected Architectures(s)
Related Issue(s) #332, #362, #324
Has Unit Tests (y/n) n
Builds Without Errors (y/n) y
Unit Tests Pass (y/n) y
Documentation Included (y/n) y

Change Description

This PR aims to resolve all but one outstanding documentation issue in #332.

Rationale

@saba-ja 👋🏻 Some updates and questions for you:

  1. The broken link was fixed in devel by Correct link to autocomplete page #362.

  2. What specific information needs to change for the unit testing tutorial to be accurate?

  3. Fixed in this PR.

  4. The text appears sufficiently similar between devel and update/ground-prototype that I've added a fix to devel in this PR. Specifically, I added a generate command based on order of operations in the Ref tutorial. Please verify for accuracy. 🙇🏻

  5. Fixed in this PR.

  6. A fix doesn't appear in devel yet either, so I've added it here.

  7. Based on Update fprime-gds option and path being used in INSTALL.md #324, it looks like -d was replaced with -r. However, unlike Update fprime-gds option and path being used in INSTALL.md #324, substitution fails here:

fprime/Ref (devel) $ fprime-gds -r
usage: fprime-gds [-h] [-l LOGS] [--log-directly] [-g {none,html}]
                  [--dictionary DICTIONARY] [-c CONFIG] [--tts-port TTS_PORT]
                  [--tts-addr TTS_ADDR] [-n] [--app APP] [-r ROOT_DIR]
                  [--ip-address ADDRESS] [--ip-port PORT]
                  [--comm-adapter {ip}]
fprime-gds: error: argument -r/--root: expected one argument

Subsequently:

fprime/Ref (devel) $ fprime-gds -r .
[ERROR] binary location Darwin/bin does not exist

Likewise:

fprime/Ref (devel) $ cd ..
fprime (devel) $ fprime-gds -r Ref/
[ERROR] binary location Ref/Darwin/bin does not exist

Note that fprime/Ref (devel) $ fprime-gds appears to work as intended.

Given errors on Darwin/bin, it seems like there are non-obvious things happening under the hood. @Joshua-Anderson 👋🏻 Can you please verify whether this particular command requires a flag; and if so, what that flag and syntax should be?

Testing/Review Recommendations

  1. Verify that the fprime-util generate --ut command is correct, and that the overall build procedure succeeds.

  2. Verify that a change inferred from Math Component F' Tutorial #171 is correct for devel.

  3. Verify the correct syntax for the ground system build command.

Future Work

Rewrite for general clarity and adherence to style guide.

@zacharysarah zacharysarah changed the title [WIP] Documentation updates for issue 332 Documentation updates for issue 332 Feb 19, 2021
@LeStarch
Copy link
Collaborator

Note, I added the cd variant to the Tutorial, but the correct usage would be to specific the build-artifact palth:

fprime-gds -r fprime/Ref/build-artifacts

@LeStarch
Copy link
Collaborator

Really appreciate your support!

@LeStarch LeStarch merged commit 5d631af into nasa:devel Feb 20, 2021
@zacharysarah zacharysarah deleted the issue-332 branch February 20, 2021 01:13
@saba-ja
Copy link
Contributor

saba-ja commented Feb 20, 2021

@zacharysarah Thank you for the fixes. Please see #332 (comment) for the updates needed for the UT tutorial

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants