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/Tutorials/GettingStarted/Tutorial.md refers to removed install command #1877

Closed
ivanperez-keera opened this issue Feb 2, 2023 · 4 comments
Labels
bug Documentation Documentation, Tutorials and References updates

Comments

@ivanperez-keera
Copy link
Member

ivanperez-keera commented Feb 2, 2023

F' Version 3.0
Affected Component docs/Tutorials/GettingStarted/Tutorial.md

Problem Description

The tutorial refers to the "install" command in the 'Build Ref Deployment' section (bold mine to highlight the issue):

Note: the user almost always wants to run the "install" command on deployments. This builds the binary like "build" but also copies the binary to the deployments "bin" directory, i.e. fprime/Ref/bin. Install is described below.

This process also built the Dictionaries for the project and places the dictionary in the "Top" folder of the deployment. This happens any time the "install" or "build" command are run on a deployment.

The user can also build a component or deployment for a cross-compile by specifying the toolchain. A previous generate for that toolchain should have been run. Again for deployments, the user typically should run "install", see below. These steps require the setup described here: RPI

The install command was removed in 20b5f29. The first tagged version that includes this commit is v2.0.0~193^2.

How to Reproduce

  1. Running the install command as implied by the text in docs/Tutorials/GettingStarted/Tutorial.md results in an error message (output of intermediate tools hidden for clarity):
$ git clone https://github.com/nasa/fprime
$ pip install -r fprime/requirements.txt
$ cd fprime/Ref
$ fprime-util generate
$ fprime-util build
$ fprime-util install
usage: fprime-util [-h]
                   {build,impl,check,generate,purge,fpp-check,hash-to-file,info,new}
                   ...
fprime-util: error: argument command: invalid choice: 'install' (choose from 'build', 'impl', 'check', 'generate', 'purge', 'fpp-check', 'hash-to-file', 'info', 'new')

Expected Behavior

The tutorial should only refer to the build command, not the install command. Any capabilities in the install command that are now present in the build command should be rephrased to indicate so.

@ivanperez-keera
Copy link
Member Author

If you want I can send a PR.

@thomas-bc thomas-bc added the Documentation Documentation, Tutorials and References updates label Feb 2, 2023
@LeStarch
Copy link
Collaborator

LeStarch commented Feb 7, 2023

Yes a PR would be awesome. fprime-util build performs the install as well, so that section just needs to be removed.

@ivanperez-keera
Copy link
Member Author

Great. I'll do that.

LeStarch pushed a commit that referenced this issue Mar 16, 2023
The tutorial refers to the "install" command in the 'Build Ref
Deployment' section.  However, that command was removed in 20b5f29, a
commit released as early as v2.0.0~193^2.

This commit removes references to the install command from the tutorial.

The mention that the build command also copies the binaries to the bin
dir is moved earlier in the text, simply because it flows better when
the rest of the note about the install command is removed.
@thomas-bc
Copy link
Collaborator

Getting Started tutorial has been modernized and renamed HelloWorld to leverage the new fprime-util new commands: https://nasa.github.io/fprime/Tutorials/HelloWorld/Tutorial.html
Closing this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Documentation Documentation, Tutorials and References updates
Projects
None yet
Development

No branches or pull requests

3 participants