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

docs: Update Incorrect Ref Executable Path #869

Merged
merged 2 commits into from
Jul 26, 2021
Merged

docs: Update Incorrect Ref Executable Path #869

merged 2 commits into from
Jul 26, 2021

Conversation

astroesteban
Copy link
Contributor

#864

Originating Project/Creator Esteban Duran
Affected Component F' Tutorial.md
Affected Architectures(s) F' Docs
Related Issue(s)
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

Change Description

Change the Installing the Ref Deployment and Running the Binary Assuming Linux section in Tutorial.md to say:

cd fprime/Ref
fprime-util build
./build-artifacts/Linux/bin/Ref # Run the deployment
CTRL-C # Exit the application

Rationale

The original documentation says to do the following:

cd fprime/Ref
fprime-util build
./bin/Linux/Ref # Run the deployment
CTRL-C # Exit the application

However, it does not create a bin directory at fprime/Ref nor does that bin directory exist anywhere inside of the project. This is misleading to individuals going through the tutorial.

Testing/Review Recommendations

Fetch the latest devel branch and go through the tutorial.

Future Work

None.

@astroesteban
Copy link
Contributor Author

astroesteban commented Jul 23, 2021

The paragraph above my change in section Installing the F´ Executable and Dictionaries is also very misleading:

Once the deployment is built, it would be nice to be able to install the binary and dictionaries. This will enable the users to
quickly find and run the deployment. This installation can be run using the following command. Everything will be installed to
the directory defining the deployment. i.e. `fprime/Ref/bin`. Install will also invoke `build` so users should use this in-place
of build for deployments.

The "it would be nice to" makes it seem like installing the build artifacts to a bin directory is a feature that hasn't been implemented yet, like a fprime-util install command, and that paragraph was just left in there as reference. If that feature isn't available yet then I suggest it be removed.

@LeStarch
Copy link
Collaborator

I agree that the paragraph you highlighted is unnecessary? Would you like to remove it, or shall I?

@astroesteban
Copy link
Contributor Author

@LeStarch I have the branch up on my machine so I can go ahead and remove it.

@LeStarch LeStarch merged commit 48dec2b into nasa:devel Jul 26, 2021
@astroesteban astroesteban deleted the fix/incomplete-ref-binary-path-in-tutorial branch July 26, 2021 19:25
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.

2 participants