Improve dev container comments for Azure RTOS (now ThreadX)

[networkfusion]

Description

Updated the comments to refer to the fact that the name has changed.

Motivation and Context

It is now Eclipse ThreadX

How Has This Been Tested?

Screenshots

Types of changes

• Improvement (non-breaking change that improves a feature, code or algorithm)
• Bug fix (non-breaking change which fixes an issue with code or algorithm)
• New feature (non-breaking change which adds functionality to code)
• Breaking change (fix or feature that would cause existing functionality to change)
• Config and build (change in the configuration and build system, has no impact on code or features)
• Dev Containers (changes related with Dev Containers, has no impact on code or features)
• Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
• Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

• My code follows the code style of this project (only if there are changes in source code).
• My changes require an update to the documentation (there are changes that require the docs website to be updated).
• I have updated the documentation accordingly (the changes require an update on the docs in this repo).
• I have read the CONTRIBUTING document.
• I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

• Documentation
  • Updated repository documentation to consistently reference the updated naming, now denoting "Eclipse ThreadX (a.k.a. Azure RTOS)." These clarifications enhance clarity when selecting and setting up development container images.

[coderabbitai]

Walkthrough

The changes update documentation comments in two Dockerfiles and the README file to clarify repository naming. References to AzureRTOS have been revised to "Eclipse ThreadX (a.k.a. Azure RTOS)" for cloning repositories and for the description of available pre-built images. No functional changes or command modifications were introduced.

Changes

File(s)	Change Summary
.devcontainer/All/Dockerfile.All.SRC, .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC	Updated comments clarifying repository cloning instructions by renaming references from "AzureRTOS" to "Eclipse ThreadX (a.k.a. Azure RTOS)".
.devcontainer/README.md	Revised descriptions to consistently refer to "Eclipse ThreadX (a.k.a. Azure RTOS)" for pre-built images and Dockerfile references.

Suggested labels

Area: Config-and-Build

Suggested reviewers

• josesimoes

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.devcontainer/All/Dockerfile.All.SRC (1)

76-78: Updated Eclipse ThreadX Clone Comment

The updated comment for cloning Eclipse ThreadX repositories now clearly states “Eclipse ThreadX (a.k.a. Azure RTOS)”. Please verify that the branch versions (v6.4.0_rel for threadx and v6.3.0_rel for netxduo) are intentional and consistent with your release strategy.

.devcontainer/README.md (1)

16-18: Consistency and Minor Spelling Improvement

The updates to the dev container selection options and Dockerfile references accurately reflect the new naming. However, the phrase “pre build container” appears in these sections; consider changing it to “pre-built container” for improved readability and to adhere to common spelling conventions.

Also applies to: 26-27

🧰 Tools

🪛 LanguageTool

[misspelling] ~16-~16: This expression is normally spelled as one or with a hyphen.
Context: ... are: * nanoFramework-All to use the pre build container with all the elements to buil...

(EN_COMPOUNDS_PRE_BUILD)

---

[misspelling] ~17-~17: This expression is normally spelled as one or with a hyphen.
Context: ... * nanoFramework-AzureRTOS to use the pre build container with all the elements to buil...

(EN_COMPOUNDS_PRE_BUILD)

---

[misspelling] ~18-~18: This expression is normally spelled as one or with a hyphen.
Context: ...ts * nanoFramework-ChibiOS to use the pre build container with all the elements to buil...

(EN_COMPOUNDS_PRE_BUILD)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75ce2fd and 1c3c757.

📒 Files selected for processing (3)

• .devcontainer/All/Dockerfile.All.SRC (1 hunks)
• .devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (1 hunks)
• .devcontainer/README.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

.devcontainer/README.md

[misspelling] ~16-~16: This expression is normally spelled as one or with a hyphen.
Context: ... are: * nanoFramework-All to use the pre build container with all the elements to buil...

(EN_COMPOUNDS_PRE_BUILD)

---

[misspelling] ~17-~17: This expression is normally spelled as one or with a hyphen.
Context: ... * nanoFramework-AzureRTOS to use the pre build container with all the elements to buil...

(EN_COMPOUNDS_PRE_BUILD)

⏰ Context from checks skipped due to timeout of 90000ms (17)

• GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
• GitHub Check: nf-interpreter (Check_Build_Options)
• GitHub Check: build-target (TI_CC1352R1_LAUNCHXL, Debug, All, 915)
• GitHub Check: build-target (TI_CC1352R1_LAUNCHXL, Debug, TI, 915)
• GitHub Check: build-target (NXP_MIMXRT1060_EVK, Debug, All)
• GitHub Check: build-target (NXP_MIMXRT1060_EVK, Debug, FreeRTOS-NXP)
• GitHub Check: build-target (ESP32_H2_THREAD, Debug, ESP32)
• GitHub Check: build-target (ESP32_C6_THREAD, Debug, ESP32)
• GitHub Check: build-target (ESP32_C3, Debug, ESP32)
• GitHub Check: build-target (ESP32_S3, Debug, ESP32)
• GitHub Check: build-target (FEATHER_S2, Debug, ESP32)
• GitHub Check: build-target (ESP_WROVER_KIT, Debug, ESP32)
• GitHub Check: build-target (M5Core2, Debug, ESP32)
• GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, All)
• GitHub Check: build-target (ST_STM32F769I_DISCOVERY, Debug, ChibiOS)
• GitHub Check: build-target (SL_STK3701A, Debug, All)
• GitHub Check: build-target (SL_STK3701A, Debug, AzureRTOS)

🔇 Additional comments (3)

.devcontainer/AzureRTOS/Dockerfile.AzureRTOS.SRC (1)

65-67: Clear and Updated Repository Clone Comment

The comment now reads “Clone repos for Eclipse ThreadX (a.k.a. Azure RTOS)” which clearly reflects the new naming convention as intended by the PR. This update improves documentation without impacting functionality.

.devcontainer/All/Dockerfile.All.SRC (1)

69-69: Enhanced STM32 Repositories Comment

The revised comment now includes “Eclipse ThreadX (a.k.a. Azure RTOS)” for the STM32 support repositories, making it more transparent which repositories are being cloned.

.devcontainer/README.md (1)

11-11: Revised Pre-Built Image Description

The entry for the Azure RTOS image now correctly identifies it as “Eclipse ThreadX (a.k.a. Azure RTOS) targets”. This clarification meets the PR objectives and improves overall documentation clarity.