Skip to content

Commit 39a67ef

Browse files
committed
Sync docs from develop
1 parent 8176b6a commit 39a67ef

File tree

8 files changed

+70
-93
lines changed

8 files changed

+70
-93
lines changed

doc/CrossCompilingMRPT.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ cmake -S. -Bbuild-cross-arm \
3838
-DCMAKE_TOOLCHAIN_FILE=doc/toolchain-gcc8-arm.cmake \
3939
-DMRPT_EIGEN_USE_EMBEDDED_VERSION=ON \
4040
-DDISABLE_ASSIMP=ON \
41-
-DDISABLE_ROS=ON \
4241
-DDISABLE_WXWIDGETS=ON \
4342
-DMRPT_BUILD_APPLICATIONS=OFF \
4443
-DMRPT_BUILD_EXAMPLES=OFF \

doc/man-pages/CMakeLists.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ if (PROG_GZIP AND PROG_POD2MAN AND MRPT_BUILD_MANPAGES)
7878
CREATE_MANPAGE_PROJECT(benchmarking-image-features)
7979
CREATE_MANPAGE_PROJECT(yaml2ini)
8080
CREATE_MANPAGE_PROJECT(ini2yaml)
81-
CREATE_MANPAGE_PROJECT(rosbag2rawlog)
8281
CREATE_MANPAGE_PROJECT(mrpt-performance)
8382
CREATE_MANPAGE_PROJECT(3d-rotation-converter)
8483
CREATE_MANPAGE_PROJECT(ros-map-yaml2mrpt)

doc/man-pages/pod/rosbag2rawlog.pod

Lines changed: 0 additions & 64 deletions
This file was deleted.

doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ charset-normalizer==3.2.0
55
docutils==0.17.1
66
idna==3.7
77
imagesize==1.4.1
8-
Jinja2==3.1.5
8+
Jinja2==3.1.6
99
latexcodec==2.0.1
1010
m2r2==0.3.2
1111
MarkupSafe==2.1.3
@@ -15,7 +15,7 @@ pybtex==0.24.0
1515
pybtex-docutils==1.0.3
1616
Pygments==2.16.1
1717
PyYAML==6.0.1
18-
requests==2.32.0
18+
requests==2.32.4
1919
six==1.16.0
2020
snowballstemmer==2.2.0
2121
Sphinx==5.3.0
@@ -29,4 +29,4 @@ sphinxcontrib-jquery==4.1
2929
sphinxcontrib-jsmath==1.0.1
3030
sphinxcontrib-qthelp==1.0.6
3131
sphinxcontrib-serializinghtml==1.1.9
32-
urllib3==2.2.2
32+
urllib3==2.5.0

doc/source/compiling.rst

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ Minimum compiler requisites:
3333
3434
# All Ubuntu versions:
3535
sudo apt install build-essential pkg-config cmake \
36-
libeigen3-dev zlib1g-dev
37-
36+
libopencv-dev libeigen3-dev zlib1g-dev \
37+
libsuitesparse-dev libjpeg-dev
38+
3839
# plus, only for Ubuntu < 22.10:
3940
sudo apt install libwxgtk3.0-gtk3-dev
4041
@@ -64,23 +65,6 @@ Minimum compiler requisites:
6465
If your Ubuntu distribution is old and does not have any of the packages
6566
above, do not worry and ignore it, MRPT CMake scripts will handle it.
6667

67-
**ROS1 support:** Install additional dependencies for ros1bridge using
68-
official Ubuntu repositories. If you already have a ROS distribution installed,
69-
doing ``source /opt/ros/xxx/setup.bash`` is enough, no further packages
70-
must be installed. Do not install these packages if you do not need
71-
the `mrpt::ros1bridge <group_mrpt_ros1bridge_grp.html>`_ module.
72-
73-
.. code-block:: bash
74-
75-
sudo apt install libcv-bridge-dev libgeometry-msgs-dev libnav-msgs-dev \
76-
librosbag-storage-dev libroscpp-dev libsensor-msgs-dev \
77-
libstd-srvs-dev libstereo-msgs-dev libtf2-dev \
78-
libtf2-msgs-dev libbz2-dev
79-
80-
**ROS2 support:** Invoke your ROS2 distribution ``setup.bash`` as usual before
81-
running MRPT cmake configure to enable building of
82-
the `mrpt::ros2bridge <group_mrpt_ros2bridge_grp.html>`_ module.
83-
8468
.. dropdown:: Windows
8569

8670
**CMake (Mandatory)**
@@ -126,6 +110,12 @@ Minimum compiler requisites:
126110
nmake -f makefile.vc BUILD=release SHARED=1 RUNTIME_LIBS=dynamic DEBUG_INFO=0 VENDOR=mrpt USE_OPENGL=1 TARGET_CPU=amd64
127111
nmake -f makefile.vc BUILD=debug SHARED=1 RUNTIME_LIBS=dynamic DEBUG_INFO=1 VENDOR=mrpt USE_OPENGL=1 TARGET_CPU=amd64
128112
113+
**OpenCV (Optional, but strongly recommended)**
114+
115+
Download the `latest OpenCV release <https://github.com/opencv/opencv/releases/latest>`_
116+
either as source code and compile it, or (easier) install the provided
117+
``opencv-x.y.z-vcZZ.exe`` installer.
118+
129119
**FFmpeg for Win32 (Optional)**
130120

131121
These libraries are optional, you will need them only if you plan to read
@@ -192,8 +182,11 @@ For all platforms/compilers:
192182
- ``MRPT_WITH_KINECT``: By default ON. Uncheck if you don’t have the required dependencies (read above for your OS).
193183
- ``BUILD_SHARED_LIBS``: Build static libraries if set to OFF, or dynamic libraries (.so/.dll) otherwise. Default is ON, and it’s strongly recommended to always use shared libs unless you have special need for static ones.
194184
- ``MRPT_EIGEN_USE_EMBEDDED_VERSION``: By default O, instructs MRPT to use the Eigen headers in MRPT/otherlibs/eigen3/. Uncheck if you have Eigen installed in the system and it’s visible through pkg-config. It’s recommended to uncheck this option if you have eigen3 installed in your system (today, eigen3 it’s not yet in any distro repository, that’s why it’s ON by default).
185+
- ``MRPT_ALWAYS_CHECKS_DEBUG``: If set to ON, additional security checks will be performed at run-time in many classes. Default is OFF.
186+
- ``MRPT_ALWAYS_CHECKS_DEBUG_MATRICES``: If set to ON, additional security checks will be performed at run-time in several Matrix operations. Default is ON.
195187
- ``MRPT_ENABLE_EMBEDDED_ENABLED_PROFILER``: If enabled, all code blocks within macros "MRPT_BEGIN/MRPT_END" will be profiled and the statistics dumped to the console at the end of execution of any program. Default is OFF.
196188
- ``MRPT_HAS_ASIAN_FONTS``: Enables Asian fonts in mrpt::img::CCanvas (see this page), but increases library size by 1.5Mb. Default is ON.
189+
- ``MRPT_HAS_SVS``: To enable integration of the Videre SVS libraries to interface their stereo cameras. You’ll need the vendor libraries installed in the system before to enable this option. After setting this option to “ON”, the new configuration fields “SVS_ROOT_DIR” will appear and will be tried to be set pointing to the directory where the library is (As of Aug/2010, this option only works in GNU/Linux).
197190
- ``MRPT_OCCUPANCY_GRID_CELLSIZE``: Can be either 8 or 16 (bits). The size of each cell in the class mrpt::slam::COccupancyGridMap2D. Default is 8 bits. More on this here.
198191

199192
For Windows only:

doc/source/doxygen-docs/changelog.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,58 @@
11
\page changelog Change Log
22

3-
# Version 2.14.8: UNRELEASED
4-
(None yet)
3+
# Version 2.15.0: UNRELEASED
4+
- None yet
5+
6+
# Version 2.14.16: Released Oct 15th, 2025
7+
- Changes in libraries:
8+
- \ref mrpt_rtti_grp
9+
- More informative error message when calling clone() on a class without copy constructor.
10+
- BUG FIXES:
11+
- Fix build building deprecated warnings in WorkerThreadsPool.
12+
- Fix mrpt::opengl::CPointCloudColoured throwing if the source cloud map may have color and color/intensity channels are actually empty.
13+
14+
# Version 2.14.15: Released Sep 29th, 2025
15+
- BUG FIXES:
16+
- Fix regression in OpenGL application crashing after last update.
17+
18+
# Version 2.14.14: Released Sep 27th, 2025
19+
- BUG FIXES:
20+
- Fix missing backported fix to build mrpt::lockHelper() on modern gcc
21+
- Fix OpenGL crashes under specific build flags: OpenGL Buffers and VBO changed so they are initialized after constructor.
22+
23+
# Version 2.14.13: Released Sep 27th, 2025
24+
- Changes in libraries:
25+
- \ref mrpt_math_grp
26+
- New classes mrpt::math::TOrientedBox, mrpt::math::TOrientedBoxf
27+
- BUG FIXES:
28+
- Fix mrpt::opengl::CEllipsoid3D wrong direction.
29+
- Fix potential race conditions in TBB-parallel particle filters with 2D gridmap.
30+
- Harden opengl unit tests against crashes on non-GPU runners.
31+
- Fix build against ffmpeg 8.0 (Debian bug #1115064)
32+
33+
# Version 2.14.12: Released Aug 31rd, 2025
34+
- Changes in libraries:
35+
- \ref mrpt_opengl_grp
36+
- New method mrpt::opengl::CPointCloudColoured::setAllPointsAlpha().
37+
38+
# Version 2.14.11: Released May 31rd, 2025
39+
- BUG FIXES:
40+
- Fix build against all tf2 versions in all active ROS 2 distributions.
41+
42+
# Version 2.14.10: Released May 23rd, 2025
43+
- BUG FIXES:
44+
- Fix build in ROS rolling: ``Unknown CMake command "ament_target_dependencies".``
45+
46+
# Version 2.14.9: Released May 17th, 2025
47+
- BUG FIXES:
48+
- Fix build with latest tf2 version.
49+
50+
# Version 2.14.8: Released Apr 25th, 2025
51+
- Build system:
52+
- Fix build w/o OpenCV.
53+
- BUG FIXES:
54+
- RawLogViewer scan matching module GUI was broken.
55+
- CCameraSensor would crash at the end of a video file input.
556

657
# Version 2.14.7: Released Dec 9th, 2024
758
- Changes in apps:

doc/source/env-vars.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ numerical value (e.g. ``1``) will be interpreted as "true".
5757

5858
- ``MRPT_WXSUBSYS_TIMEOUT_MS``: The timeout in milliseconds to wait
5959
in mrpt::gui windows constructors until the wxWidgets thread processes and
60-
really creates the window, before reporting an error.
60+
really creates the window, before reporting an error. It's also used in
61+
the function mrpt::hwdrivers::prepareVideoSourceFromUserSelection().
6162
Default: ``5000`` in Release builds, ``30000`` in Debug builds.
6263

6364
- ``MRPT_YAML_PARSER_VERBOSE``: Set to ``1`` to show verbose debug information

doc/source/modules.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ Each MRPT library source code can be found under ``${MRPT_ROOT}/libs``.
4242
group_mrpt_opengl_grp.rst
4343
group_mrpt_poses_grp.rst
4444
group_mrpt_random_grp.rst
45-
group_mrpt_ros1bridge_grp.rst
46-
group_mrpt_ros2bridge_grp.rst
4745
group_mrpt_round.rst
4846
group_mrpt_rtti_grp.rst
4947
group_mrpt_serialization_grp.rst

0 commit comments

Comments
 (0)