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 Mac OS tracy info to profiling docs #13826

Merged
merged 5 commits into from
Jul 8, 2024

Conversation

mweatherley
Copy link
Contributor

Explanation

I got kind of lost on this earlier (the Tracy docs are not very helpful) and required some assistance, so I thought it might be helpful to add this somewhere in the profiling docs. The way it's presently inserted is kind of awkward, but I don't know enough about the other operating systems to make similar sections for them, which I think would be helpful, since it's going to be different on each one.

@mweatherley mweatherley added the C-Docs An addition or correction to our documentation label Jun 12, 2024
Copy link
Member

@BD103 BD103 left a comment

Choose a reason for hiding this comment

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

Looks good, though this should be moved to the Contributor's Guide once that is more finished. :)

@BD103 BD103 added D-Trivial Nice and easy! A great choice to get started with Bevy O-MacOS Specific to the MacOS (Apple) desktop operating system A-Diagnostics Logging, crash handling, error reporting and performance analysis X-Uncontroversial This work is generally agreed upon S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jun 13, 2024
@janhohenheim janhohenheim added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Jun 25, 2024
@alice-i-cecile
Copy link
Member

@mweatherley I'll merge this once the merge conflicts and linting errors are resolved.

@BD103
Copy link
Member

BD103 commented Jul 1, 2024

This is the markdownlint error message for reference, copied from CI:

/github/workspace/docs/profiling.md:45:1 MD033/no-inline-html Inline HTML [Element: details]
/github/workspace/docs/profiling.md:46:3 MD033/no-inline-html Inline HTML [Element: summary]
/github/workspace/docs/profiling.md:48:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/github/workspace/docs/profiling.md:48:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
/github/workspace/docs/profiling.md:49:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/github/workspace/docs/profiling.md:49:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
/github/workspace/docs/profiling.md:50:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/github/workspace/docs/profiling.md:50:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 2]
/github/workspace/docs/profiling.md:50:43 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
/github/workspace/docs/profiling.md:51:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4]

@mweatherley
Copy link
Contributor Author

Yeah, the issue is just that it has to be redone completely, since the current formatting can't actually be done in markdown without inline HTML. I can try rewriting the section in a way that incorporates it, I guess.

docs/profiling.md Outdated Show resolved Hide resolved
docs/profiling.md Outdated Show resolved Hide resolved
mweatherley and others added 2 commits July 2, 2024 10:37
Co-authored-by: Jerome Humbert <djeedai@gmail.com>
docs/profiling.md Outdated Show resolved Hide resolved
Co-authored-by: Jan Hohenheim <jan@hohenheim.ch>
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jul 8, 2024
Merged via the queue into bevyengine:main with commit b30b0a7 Jul 8, 2024
27 checks passed
@mweatherley mweatherley deleted the patch-1 branch July 8, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy O-MacOS Specific to the MacOS (Apple) desktop operating system S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants