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.

Sign up for GitHub

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

Jump to bottom

Full IceOryx Public API Cheat Sheet #283

Closed
4 tasks done
elfenpiff opened this issue Sep 11, 2020 · 2 comments · Fixed by #445 or #457
Closed
4 tasks done

Full IceOryx Public API Cheat Sheet #283

elfenpiff opened this issue Sep 11, 2020 · 2 comments · Fixed by #445 or #457
Assignees
@MatthiasKillat
Labels
documentation Improvements or additions to documentation
Milestone
High prio

Comments

@elfenpiff
Copy link
Contributor

elfenpiff commented Sep 11, 2020 •
edited by dkroenke
Loading

Brief feature description

We require a cheat sheet which provides a quick and complete overview over all IceOryx features from a use case point of view.
This cheat sheet should come with an example which uses all those features.

  • Update CMake Docu and check for consistency
  • Explain cmake options in detail
  • Explain the ideas, concept of optional and expected
  • Update icedelivery documentation to new API
@elfenpiff elfenpiff added the documentation Improvements or additions to documentation label Sep 11, 2020
@elfenpiff elfenpiff self-assigned this Sep 11, 2020
@elfenpiff elfenpiff changed the title Full IceOryx API Cheat Sheet Full IceOryx Public API Cheat Sheet Sep 11, 2020
elfenpiff added a commit to elfenpiff/iceoryx that referenced this issue Sep 11, 2020
@elfenpiff
iox-eclipse-iceoryx#283 fixed missing include in topic data and added…
2e7b2c4 
… first cheat sheet draft

Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff added a commit to elfenpiff/iceoryx that referenced this issue Sep 11, 2020
@elfenpiff
Merge remote-tracking branch 'origin/iox-#218-improve-pub-sub-api' in…
57b06dc 
…to iox-eclipse-iceoryx#283-api-cheat-sheet
elfenpiff added a commit to elfenpiff/iceoryx that referenced this issue Sep 11, 2020
@elfenpiff
iox-eclipse-iceoryx#283 using new experimental api for cheat sheet
6f5c61e 
Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff added a commit to elfenpiff/iceoryx that referenced this issue Sep 11, 2020
@elfenpiff
iox-eclipse-iceoryx#283 noted open question
40e26dd 
Signed-off-by: Christian Eltzschig <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 21, 2020
@FerdinandSpitzschnueffler
iox-eclipse-iceoryx#283: add example description
3c29574 
Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 21, 2020
@FerdinandSpitzschnueffler
Merge remote-tracking branch 'origin/iox-#218-improve-pub-sub-api' in…
a5404f7 
…to iox-eclipse-iceoryx#283-api-cheat-sheet

Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 23, 2020
@FerdinandSpitzschnueffler
Merge remote-tracking branch 'origin/iox-#218-improve-pub-sub-api' in…
4cc543f 
…to iox-eclipse-iceoryx#283-api-cheat-sheet
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 23, 2020
@FerdinandSpitzschnueffler
iox-eclipse-iceoryx#283: add subscriber examples and adapt publisher …
de75f23 
…examples to API changes

Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 24, 2020
@FerdinandSpitzschnueffler
iox-eclipse-iceoryx#283: add example for subscription state check
aaf4c47 
Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 24, 2020
@FerdinandSpitzschnueffler
iox-eclipse-iceoryx#283: fix acquirePreviousSendData
442da0f 
Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
FerdinandSpitzschnueffler added a commit to elfenpiff/iceoryx that referenced this issue Sep 29, 2020
@FerdinandSpitzschnueffler
iox-eclipse-iceoryx#283: add last examples for untyped pub/sub
d2d7da3 
Signed-off-by: Lehmann Marika (CC-AD/ESW1) <[email protected]>
@mossmaurice mossmaurice added this to the v1.0 milestone Nov 3, 2020
@budrus budrus mentioned this issue Nov 10, 2020
Closed
13 tasks
@elfenpiff elfenpiff modified the milestones: Prio 1, CW47-20-I Nov 11, 2020
@elfenpiff elfenpiff modified the milestones: CW47-20-I, Prio 1 Nov 11, 2020
@MatthiasKillat
Copy link
Contributor

I do think explaining optional and expected in detail belongs elsewhere, but I will include a short description. We already have one for expected in error-handling.md, I will link that I guess.

We need to consolidate our documentation, but this belongs to a different issue (which may be worth creating). This should be done for 1.0 but not 0.9.

@MatthiasKillat MatthiasKillat mentioned this issue Dec 14, 2020
Merged
19 tasks
MatthiasKillat added a commit to ApexAI/iceoryx that referenced this issue Dec 15, 2020
@MatthiasKillat
iox-eclipse-iceoryx#283 cheat sheet doc structure
4419539 
Signed-off-by: Matthias Killat <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 20, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Fix past tense
4ceda5e 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 20, 2020
@mossmaurice
iox-eclipse-iceoryx#283 ..everywhere
ed0104f 
Signed-off-by: Simon Hoinkis <[email protected]>
@mossmaurice mossmaurice mentioned this issue Dec 20, 2020
Merged
19 tasks
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 20, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Fix some findings in icedelivery readme
7c56cd5 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 20, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Fix ice_multi_publisher example
4282ad9 
Signed-off-by: Simon Hoinkis <[email protected]>
MatthiasKillat added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@MatthiasKillat
iox-eclipse-iceoryx#283 clarifcation and extension of overview.md
473fe14 
Signed-off-by: Matthias Killat <[email protected]>
MatthiasKillat added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@MatthiasKillat
iox-eclipse-iceoryx#283 added clarification to the untyped example
a59f848 
Signed-off-by: Matthias Killat <[email protected]>
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@dkroenke
iox-eclipse-iceoryx#283 spell check
0db0dc8 
Signed-off-by: Dietrich Krönke <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Rename ServiceDescription in icedelivery and …
0bbb195 
…fix icecrystal command

Signed-off-by: Simon Hoinkis <[email protected]>
MatthiasKillat added a commit that referenced this issue Dec 21, 2020
@MatthiasKillat
Merge pull request #445 from ApexAI/iox-#283-create-iceoryx-api-cheat…
2216c42 
…-sheet

Iox #283 Add overview.md and introduce new docu structure
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Remove WaitSet from icedelivery example to al…
68f3110 
…ign with icedelivery_on_c

Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Update expected output of icedelivery example
9e4dac7 
Signed-off-by: Simon Hoinkis <[email protected]>
@mossmaurice mossmaurice mentioned this issue Dec 21, 2020
Merged
19 tasks
dkroenke added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@dkroenke
iox-eclipse-iceoryx#283 try to fix colcon build
3653761 
Signed-off-by: Dietrich Krönke <[email protected]>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
iox-eclipse-iceoryx#283 added example with history usage
723590f 
Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
Merge branch 'iox-eclipse-iceoryx#283-make-icedelivery-and-icerdelive…
ccef3e1 
…ry-on-c-consistent' of github.com:ApexAI/iceoryx into iox-eclipse-iceoryx#283-make-icedelivery-and-icerdelivery-on-c-consistent
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
iox-eclipse-iceoryx#283 updated headers which where forgotten in PR e…
a1af3f7 
…clipse-iceoryx#450

Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
iox-eclipse-iceoryx#283 adjusted readme in the c example and added so…
a7885f8 
…me explanatory comments

Signed-off-by: Christian Eltzschig <[email protected]>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
iox-eclipse-iceoryx#283 adjusted copyright headers
66c85b8 
Signed-off-by: Christian Eltzschig <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Remove WaitSet left-overs
f011f22 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Clean-up includes in icedelivery
1f55d24 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Add SubscribeState hint
90940f6 
Signed-off-by: Simon Hoinkis <[email protected]>
elfenpiff added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elfenpiff
iox-eclipse-iceoryx#283 fixed app names for example, new comment on e…
3dc40f1 
…xplaining the history, got rid of dead code

Signed-off-by: Christian Eltzschig <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
Merge remote-tracking branch 'origin/master' into iox-eclipse-iceoryx…
f6b924e 
…#283-make-icedelivery-and-icerdelivery-on-c-consistent
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@elBoberido
iox-eclipse-iceoryx#283 set target properties for icedelivery history…
3d0cc6a 
… example

Signed-off-by: Mathias Kraus <[email protected]>
mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Dec 21, 2020
@mossmaurice
iox-eclipse-iceoryx#283 Fix includes (again) in icedelivery
c5a30ba 
Signed-off-by: Simon Hoinkis <[email protected]>
mossmaurice added a commit that referenced this issue Dec 21, 2020
@mossmaurice
Merge pull request #457 from ApexAI/iox-#283-make-icedelivery-and-ice…
dde4175 
…rdelivery-on-c-consistent

Iox #283 Remove WaitSet from icedelivery example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MatthiasKillat MatthiasKillat

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
High prio
3 participants
@mossmaurice @elfenpiff @MatthiasKillat