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

Naming convention for iceoryx binaries #147

Closed
orecham opened this issue Jun 18, 2020 · 4 comments
Closed

Naming convention for iceoryx binaries #147

orecham opened this issue Jun 18, 2020 · 4 comments
Assignees
Labels
refactoring Refactor code without adding features

Comments

@orecham
Copy link
Contributor

orecham commented Jun 18, 2020

Brief feature description

Iceoryx exports multiple binaries. Should there be a naming convention for them ? If yes, what should this be ?

@orecham
Copy link
Contributor Author

orecham commented Jul 22, 2020

Currently, we have the following binaries:

  • gateway_dds2iceoryx
  • gateway_iceoryx2dds
  • iceoryx_introspection_client
  • iceperf-hardy
  • iceperf-laurel
  • ice-publisher-bare-metal
  • ice-publisher-simple
  • ice-subscriber-bare-metal
  • ice-subscriber-simple
  • RouDi

Suggestion: streamline naming to follow the following convention: iox-${application_name}

@elBoberido
Copy link
Member

elBoberido commented Jul 22, 2020

so we would have something like

  • iox-roudi
  • iox-gw-dds2iceoryx
  • iox-gw-iceoryx2dds
  • etc.

I like that.
I'm not sure if we should also do it for our examples or just for binaries we would distribute in a release

@orecham
Copy link
Contributor Author

orecham commented Jul 22, 2020

I would vote to use it for all of them for consistency... I like the idea of being able to just type in my terminal: iox- <tab> <tab> and easily see the list of iceoryx applications.

I am not too fussed though, if there is a strong want/need to break the convention for examples then we can leave them as is.

orecham added a commit to MatthiasKillat/iceoryx that referenced this issue Jul 23, 2020
Signed-off-by: Ithier Jeff (CC-AD/EYF1) <[email protected]>
orecham added a commit to MatthiasKillat/iceoryx that referenced this issue Jul 23, 2020
Signed-off-by: Ithier Jeff (CC-AD/EYF1) <[email protected]>
orecham added a commit to MatthiasKillat/iceoryx that referenced this issue Jul 23, 2020
@elBoberido
Copy link
Member

I also don't have strong feelings about this. We should maybe use something like an iox-ex- prefix.
@MatthiasKillat, what's your opinion regarding a prefix for examples? I know we had a discussion in the past regarding something similar.

@orecham orecham closed this as completed Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactor code without adding features
Projects
None yet
Development

No branches or pull requests

3 participants