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.

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

Update application tracing part of README.md #818

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Conversation

sigmaaa
Copy link
Collaborator

@sigmaaa sigmaaa commented Sep 13, 2023

Description

small update of application tracing docs. The default project on esp-idf 5.1 has changed from app_trace_to_host to app_trace_basic

Summary by CodeRabbit

  • Documentation
    • Updated links to example projects for Application Level Tracing in ESP-IDF.
    • Added instructions for creating a debug configuration before using application-level tracing.

@sigmaaa sigmaaa self-assigned this Sep 13, 2023
@coderabbitai
Copy link

coderabbitai bot commented Sep 13, 2023

Walkthrough

The documentation for Application Level Tracing in ESP-IDF has been updated to correct and enhance the user experience. Links to example projects have been fixed and a new example has been added for versions 5.1 and higher. Additionally, it now includes a note on the necessity of creating a debug configuration prior to using application-level tracing.

Changes

File(s) Change Summary
README.md Updated links to example projects and added a note about creating a debug configuration for Application Level Tracing in ESP-IDF.

🐇🍂 "In the fall, as leaves descend,
We update links, a helping hand.
Tracing paths with care anew,
CodeRabbit guides with clues so true." 🌐✨


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 31b7055 and 771b52c commits.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolipakakondal kolipakakondal added needs translation:CN Chinese translation is required documentation Improvements or additions to documentation labels Sep 28, 2023
@kolipakakondal kolipakakondal added this to the v2.12.0 milestone Sep 28, 2023
@kolipakakondal
Copy link
Collaborator

Hi @sigmaaa Please resolve the conflicts and merge this pr

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0a16bbb and 19f3355.
Files selected for processing (1)
  • README.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • README.md

@sigmaaa sigmaaa merged commit 7ed1e5f into master Nov 15, 2023
4 checks passed
@kolipakakondal kolipakakondal deleted the App-Tracing-doc-update branch May 10, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs translation:CN Chinese translation is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants