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

[21114] Check suprocess return codes on RDT generation #795

Merged
merged 1 commit into from
Jun 5, 2024
Merged

[21114] Check suprocess return codes on RDT generation #795

merged 1 commit into from
Jun 5, 2024

Conversation

EduPonz
Copy link

@EduPonz EduPonz commented Jun 5, 2024 •
edited
Loading

Description

This PR makes the RDT generation to fail if either of the doxygen or swig commands fails. Not checking them was causing the documentation to build with API reference errors.

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

Related implementation PR:

NOTE: As RTD build is not ready to take the appropriate Fast DDS branch and will choose master, the build will failed until eProsima/Fast-DDS#4896 is merged. I've verified on a Ubuntu 20.04 docker that the doxygen is generated without errors with that Fast DDS PR.

Contributor Checklist

  • Commit messages follow the project guidelines.
  • N/A: Code snippets related to the added documentation have been provided.
  • Documentation tests pass locally.
  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • CI passes without warnings or errors.

@EduPonz EduPonz added this to the v3.0.0 milestone Jun 5, 2024
@EduPonz EduPonz mentioned this pull request Jun 5, 2024
Merged
7 tasks
@EduPonz
Copy link
Author

EduPonz commented Jun 5, 2024

@richiprosima please test_3 docs

@EduPonz EduPonz merged commit 0974196 into master Jun 5, 2024
3 checks passed
@EduPonz EduPonz deleted the hotfix/doxygen_errors branch June 5, 2024 10:51
@EduPonz
Copy link
Author

EduPonz commented Jun 5, 2024

@Mergifyio backport 2.14.x 2.13.x 2.10.x 2.6.x

@mergify Mergify
Copy link

mergify bot commented Jun 5, 2024 •
edited
Loading

backport 2.14.x 2.13.x 2.10.x 2.6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jun 5, 2024
@EduPonz @mergify
Check subprocess return codes on RDT generation (#795)
cb19fee 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
@EduPonz @mergify
Check subprocess return codes on RDT generation (#795)
87eb73a 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
@EduPonz @mergify
Check subprocess return codes on RDT generation (#795)
6c16374 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
This was referenced Jun 5, 2024
Merged
Merged
Merged
mergify bot pushed a commit that referenced this pull request Jun 5, 2024
@EduPonz @mergify
Check subprocess return codes on RDT generation (#795)
fa81240 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
@mergify mergify bot mentioned this pull request Jun 5, 2024
Open
7 tasks
Mario-DL pushed a commit that referenced this pull request Jun 27, 2024
@EduPonz @Mario-DL
Check subprocess return codes on RDT generation (#795)
0201c37 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
EduPonz added a commit that referenced this pull request Jul 2, 2024
@EduPonz
Check subprocess return codes on RDT generation (#795)
eb179f4 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Check suprocess return codes on RDT generation (#795) (#796)
664ea54 
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Check subprocess return codes on RDT generation (#795)
1e5c8dd 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz @JesusPoderoso
Check suprocess return codes on RDT generation (#795) (#796)
7016602 
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@EduPonz @JesusPoderoso
Check subprocess return codes on RDT generation (#795)
913b818 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <[email protected]>
JesusPoderoso pushed a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz @JesusPoderoso
Check suprocess return codes on RDT generation (#795) (#796)
8d3700f 
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz @JesusPoderoso
Check suprocess return codes on RDT generation (#795) (#797)
f0dce94 
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)
Signed-off-by: JesusPoderoso <[email protected]>

* Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>

* Refs #21114: TODO DROP - Check against Fast DDS branch

Signed-off-by: JesusPoderoso <[email protected]>

* Revert "Refs #21114: TODO DROP - Check against Fast DDS branch"

This reverts commit fd27b9f.

Signed-off-by: JesusPoderoso <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Signed-off-by: JesusPoderoso <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: JesusPoderoso <[email protected]>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@EduPonz
Check subprocess return codes on RDT generation (#795)
d6db6d3 
Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
EduPonz added a commit that referenced this pull request Jul 3, 2024
@mergify @EduPonz
Check subprocess return codes on RDT generation (#795) (#798)
92e84af 
* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

Check suprocess return codes on RDT generation (#795) (#796)

* Check subprocess return codes on RDT generation (#795)

Signed-off-by: eduponz <[email protected]>
(cherry picked from commit 0974196)

* Refs #21114: Remove unsued Doxyfile EXAMPLE_PATH

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fix Fast DDS Python API reference warnings regarding Qos aliases

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Fail generation when docutils errors

Signed-off-by: eduponz <[email protected]>

* Refs #21114: Use correct branches of Fast DDS and Fast DDS Python in RTD

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>

* Set English as doc language

Signed-off-by: eduponz <[email protected]>

---------

Signed-off-by: eduponz <[email protected]>
Co-authored-by: Eduardo Ponz Segrelles <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mario-DL Mario-DL Mario-DL approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@EduPonz @Mario-DL