iox-#2305 Fix typos across the project

[antonkesy]

Notes for Reviewer

Sorry, I accidentally renamed the remote branch which auto-closed my existing PR #2538
Therefore, this is the continuation.

This PR fixes typos in docs, comments, and string literals. It should not change any behavior of the code.

It's quite huge (sorry), but should be fairly easy to check

If this is not suitable, needs changes, ... please let me know :)

Pre-Review Checklist for the PR Author

1. Code follows the coding style of CONTRIBUTING.md
2. [~] Tests follow the best practice for testing
3. [~] Changelog updated in the unreleased section including API breaking changes
4. Branch follows the naming format (iox-123-this-is-a-branch)
5. Commits messages are according to this guideline
   • Commit messages have the issue ID (iox-#123 commit text)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
6. Update the PR title
   • Follow the same conventions as for commit messages
   • Link to the relevant issue
7. Relevant issues are linked
8. Add sensible notes for the reviewer
9. All checks have passed (except task-list-completed)
10. Assign PR to reviewer

Checklist for the PR Reviewer

• Consider a second reviewer for complex new features or larger refactorings
• Commits are properly organized and messages are according to the guideline
• Code according to our coding style and naming conventions
• [~] Unit tests have been written for new behavior
• [~] Public API changes are documented via doxygen
• [~] Copyright owner are updated in the changed files
• [~] All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

• Relates to Ongoing Issue: Small Documentation Tasks #2305

[antonkesy]

Reply to elBoberido in #2538

@antonkesy it seems some of the changes you made require to run clang-format on that files. Also, can you edit the commit messages and prepend iox-2305? #2305 is the issue number for small documentation fixes like the ones you did.

Thank you for your guidance! Prepend it to the commits & branch.
Interestingly I've never seen GitHub auto-expand the commit name:
From iox-#2305 Fix typos across the project to iox-eclipse-iceoryx#2305 Fix typos in docs

I've run clang-format-18 locally, but I'm not 100% sure if I'm correct ^^ well see if the CI accepts it :)
I've used clang-format-18 (since this is what the CI uses AFAIK), but the .clang-format files states 13. (Might be an outdated comment)

It also might not be clear to new contributors, but this repo is basically in maintenance mode and the development has fully shifted to iceoryx2. So while we appreciate your contribution, there will most probably no further major release from this repo. We would of course also appreciate if you look at the iceoryx2 repo for typos. I guess we also have plenty of them there.

Thank you for the hint! I'll take a look ;)

[elBoberido]

Thank you for your guidance! Prepend it to the commits & branch. Interestingly I've never seen GitHub auto-expand the commit name: From iox-#2305 Fix typos across the project to iox-eclipse-iceoryx#2305 Fix typos in docs

That's why we changed the format to [#123] to have it less weird with the expansion :)

I've run clang-format-18 locally, but I'm not 100% sure if I'm correct ^^ well see if the CI accepts it :) I've used clang-format-18 (since this is what the CI uses AFAIK), but the .clang-format files states 13. (Might be an outdated comment)

Yeah, I guess we just forgot to update the .clang-format file 😅

[codecov]

Codecov Report

❌ Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.87%. Comparing base (bc57364) to head (73602b9).

Files with missing lines	Patch %	Lines
...ceoryx_hoofs/posix/filesystem/source/file_lock.cpp	0.00%	1 Missing ⚠️
iceoryx_posh/source/roudi/process_manager.cpp	0.00%	1 Missing ⚠️
iceoryx_posh/source/roudi/roudi.cpp	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2539   +/-   ##
=======================================
  Coverage   77.87%   77.87%           
=======================================
  Files         446      446           
  Lines       16301    16301           
  Branches     2320     2320           
=======================================
  Hits        12695    12695           
  Misses       2759     2759           
  Partials      847      847           

Flag	Coverage Δ
unittests	77.70% <40.00%> (ø)
unittests_timing	15.00% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ox/detail/mpmc_lockfree_queue/mpmc_index_queue.inl	84.21% <ø> (ø)
..._lockfree_queue/mpmc_resizeable_lockfree_queue.inl	90.41% <ø> (ø)
...lude/iox/detail/mpmc_resizeable_lockfree_queue.hpp	100.00% <ø> (ø)
...x_hoofs/concurrent/sync/include/iox/smart_lock.hpp	100.00% <ø> (ø)
...ceoryx_hoofs/container/include/iox/detail/list.inl	91.23% <ø> (ø)
...oofs/container/include/iox/uninitialized_array.hpp	100.00% <ø> (ø)
iceoryx_hoofs/container/include/iox/vector.hpp	100.00% <ø> (ø)
..._hoofs/design/include/iox/move_and_copy_helper.hpp	100.00% <ø> (ø)
...unctional/include/iox/detail/storable_function.hpp	100.00% <ø> (ø)
...ofs/memory/include/iox/detail/relative_pointer.inl	96.38% <ø> (ø)
... and 37 more

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[elBoberido]

@antonkesy thanks for your contribution :)

[antonkesy]

@antonkesy thanks for your contribution :)

A pleasure :) Thank you for your help!