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

Add enhance tracing and shader compilation docs to DevTools #6866

Merged
merged 2 commits into from
Mar 2, 2022
Merged

Add enhance tracing and shader compilation docs to DevTools #6866

merged 2 commits into from
Mar 2, 2022

Conversation

johnpryan
Copy link
Contributor

Adds enhance tracing and shader compilation docs to the DevTools performance page.

fixes #6749
fixes #6752

@kenzieschmoll

staged:

https://flutter-website-jr-stagi-988d4.web.app/development/tools/devtools/performance

Presubmit checklist

app. Frames that are performing shader compilation are marked in dark
red:

![Screenshot of shader compilation for a frame]({{site.url}}/assets/images/docs/tools/devtools/shader-compilation-frames-chart.png)
Copy link
Member

Choose a reason for hiding this comment

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

I would use a different screenshot that shows a janky frame with shader compilation time. A warning icon will show up if the frame is actually janky. Also could be good to show the tooltip when you hover over the janky frame, which will show how much time on the raster thread was spent compiling shaders.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure why, but in looking at the staged version, this image isn't displayed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kenzieschmoll SGTM

@sfshaza2 When I stage the site it tries to load the image from docs.flutter.dev, and it doesn't exist yet. I think I can edit _config.yml to change site.url to point to my staging site, though.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I hadn't run into this yet. Don't worry about it!

src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

a few nits

src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
app. Frames that are performing shader compilation are marked in dark
red:

![Screenshot of shader compilation for a frame]({{site.url}}/assets/images/docs/tools/devtools/shader-compilation-frames-chart.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure why, but in looking at the staged version, this image isn't displayed.

src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
src/development/tools/devtools/performance.md Outdated Show resolved Hide resolved
@johnpryan
Copy link
Contributor Author

cc: @InMatrix

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

lgtm

app. Frames that are performing shader compilation are marked in dark
red:

![Screenshot of shader compilation for a frame]({{site.url}}/assets/images/docs/tools/devtools/shader-compilation-frames-chart.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I hadn't run into this yet. Don't worry about it!

@sfshaza2 sfshaza2 merged commit 3ad94ed into flutter:main Mar 2, 2022
AlexV525 pushed a commit to AlexV525/flutter-website that referenced this pull request Mar 26, 2022
…6866)

* Add docs for enhance tracing and shader compilation in DevTools

* Address code review comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs for shader compilation Add Enhance Tracing docs
3 participants