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

Improve cmake function naming/documentation for cfe 6.6 branch #16

Open
SpaceSteve121 opened this issue Jul 29, 2019 · 0 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@SpaceSteve121
Copy link
Contributor

Some new users are reporting that its hard to figure out how to build a CFS app with ECI (example #9 ). I think this can be partially addressed by pointing them at the CI pipeline as a "recipe", but I think it would be helpful to add some better breadcrumbs for them to follow.

As a couple examples, I'd suggest perhaps:

  • renaming setup_cfe.cmake to eci_utils.cmake or something similar, to reflect that there are functions in there for doing more than just setting up cfe (sets up CFS system, also some helper functions for integrating ECI apps, etc).
  • add docstrings for each function in that file explaining the result of each and perhaps at what point in the integration process its useful.
  • ensure that the function names reflect their purpose. For example, I think create_cfe() might be more aptly called clone_cfs or clone_cfs_if_not_exist (though that's a little verbose). install_eci I think performs multiple operations (integrates to/sch/ci files, install eci source, etc) but from the name I'd think it only puts the ECI source files into the CFS tree.
  • Ensure that functions output messages to track their progress, which can also help document the functions.

Let me know if this makes sense and we can discuss any specific changes here as well.

@SpaceSteve121 SpaceSteve121 added the enhancement New feature or request label Jul 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants