Skip to content

Commit 0a36722

Browse files
Cosmetic fixes for Developer Guide. (#5872) (#5889)
* Cosmetic fixes for Developer Guide. * add link anchor for target platforms and architectures. * use internal doc link for ROS PMC constituents and committers. --------- (cherry picked from commit c3ef599) Signed-off-by: Tomoya.Fujita <[email protected]> Signed-off-by: Tomoya.Fujita <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
1 parent ec1e330 commit 0a36722

File tree

2 files changed

+14
-19
lines changed

2 files changed

+14
-19
lines changed

source/Installation.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Options for installing ROS 2 {DISTRO_TITLE_FULL}:
1818
Installation/Testing
1919
Installation/RMW-Implementations
2020

21+
.. _binary-package-platforms:
22+
2123
Binary packages
2224
---------------
2325

@@ -26,17 +28,17 @@ If you are not running any of the following operating systems you may need to bu
2628

2729
We provide ROS 2 binary packages for the following platforms:
2830

29-
* Ubuntu Linux - Noble Numbat (24.04)
31+
* Ubuntu Linux (amd64 / aarch64) - Noble Numbat (24.04)
3032

3133
* :doc:`deb packages <Installation/Ubuntu-Install-Debs>` (recommended)
3234
* :doc:`binary archive <Installation/Alternatives/Ubuntu-Install-Binary>`
3335

34-
* RHEL 9
36+
* Red Hat Enterprise Linux 9 (amd64)
3537

3638
* :doc:`RPM packages <Installation/RHEL-Install-RPMs>` (recommended)
3739
* :doc:`binary archive <Installation/Alternatives/RHEL-Install-Binary>`
3840

39-
* Windows 10
41+
* Windows 10 (amd64)
4042

4143
* :doc:`Windows Binary (VS 2019) <Installation/Windows-Install-Binary>`
4244

source/The-ROS2-Project/Contributing/Developer-Guide.rst

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,11 @@ Guidelines for backporting PRs
159159
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160160

161161
When changing an older version of ROS:
162-
163162
* Make sure the features or fixes are accepted and merged in the rolling branch before opening a PR to backport the changes to older versions.
164163
* When backporting to older versions, also consider backporting to any other :doc:`still supported versions <../../Releases>`, even non-LTS versions.
165164
* If you are backporting a single PR in its entirety, title the backport PR "[Distro] <name of original PR>".
166-
If backporting a subset of changes from one or multiple PRs, the title should be "[Distro] <description of changes>".
167165
* Link to all PRs whose changes you're backporting from the description of your backport PR.
168-
In a Dashing backport of a Foxy change, you do not need to link to the Eloquent backport of the same change.
166+
* Package maintainers typically use `Mergifyio <https://mergify.com/>`_ to automatically backport PRs to downstream distributions when needed, however developers can still perform manual backporting operations as described above when necessary.
169167

170168
Documentation
171169
^^^^^^^^^^^^^
@@ -360,7 +358,8 @@ Pull requests
360358
As the opener of a pull-request, if you are working in a fork, checking the box to `allow edits from upstream contributors <https://github.com/blog/2247-improving-collaboration-with-forks>`__ will assist with the aforementioned.
361359
As a reviewer, also feel free to make more substantial improvements, but consider putting them in a separate branch (either mention the new branch in a comment, or open another pull request from the new branch to the original branch).
362360

363-
* Any developer (the author, the reviewer, or somebody else) can merge any approved pull request.
361+
* Only maintainers and committers can merge approved pull requests into the mainline.
362+
See the :doc:`current ROS PMC constituents and committers <../Governance>` for the list of people with merge permissions.
364363

365364
Library versioning
366365
^^^^^^^^^^^^^^^^^^
@@ -759,26 +758,16 @@ The build farm is located at `ci.ros2.org <https://ci.ros2.org/>`__.
759758
Every night we run nightly jobs which build and run all the tests in various scenarios on various platforms.
760759
Additionally, we test all pull requests against these platforms before merging.
761760

762-
This is the current set of target platforms and architectures, though it evolves overtime:
763-
764-
765-
* Ubuntu 24.04 Noble
766-
767-
* amd64
768-
* aarch64
769-
770-
* Windows 10
771-
772-
* amd64
761+
Check :ref:`the current set of target platforms and architectures <binary-package-platforms>`, though it evolves overtime.
773762

774763
There are several categories of jobs on the buildfarm:
775764

776-
777765
* manual jobs (triggered manually by developers):
778766

779767
* ci_linux: build + test the code on Ubuntu
780768
* ci_linux-aarch64: build + test the code on Ubuntu on an ARM 64-bit machine (aarch64)
781769
* ci_linux_coverage: build + test + generation of test coverage
770+
* ci_linux-rhel: build + test the code on Red Hat Enterprise Linux
782771
* ci_windows: build + test the code on Windows
783772
* ci_launcher: trigger all the jobs listed above
784773

@@ -788,18 +777,21 @@ There are several categories of jobs on the buildfarm:
788777

789778
* nightly_linux_debug
790779
* nightly_linux-aarch64_debug
780+
* nightly_linux-rhel_debug
791781
* nightly_win_deb
792782

793783
* Release: build + test the code with CMAKE_BUILD_TYPE=Release
794784

795785
* nightly_linux_release
796786
* nightly_linux-aarch64_release
787+
* nightly_linux-rhel_release
797788
* nightly_win_rel
798789

799790
* Repeated: build then run each test up to 20 times or until failed (aka flakiness hunter)
800791

801792
* nightly_linux_repeated
802793
* nightly_linux-aarch64_repeated
794+
* nightly_linux-rhel_repeated
803795
* nightly_win_rep
804796

805797
* Coverage:
@@ -812,6 +804,7 @@ There are several categories of jobs on the buildfarm:
812804
* packaging (run every night; result is bundled into an archive):
813805

814806
* packaging_linux
807+
* packaging_linux-rhel
815808
* packaging_windows
816809

817810
Two additional build farms support the ROS / ROS 2 ecosystem by providing building of source and

0 commit comments

Comments
 (0)