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

[doc] Minor documentation updates #737

Merged
merged 2 commits into from
Feb 28, 2024
Merged

Conversation

Arpafaucon
Copy link
Contributor

@Arpafaucon Arpafaucon commented Feb 27, 2024

  • [tech doc] remove section on custom thread naming
  • [user + tech doc] update macro name for libunwind

Sorry, my editor got rid of some trailing whitespaces on the way. I don't think that should be a problem, but I can revert that if you want.

I plan on doing some more investigation on the code and might find other things worthy of a MR.
If this MR is still open I can add them there to spare you a review round - but since I don't know your release plan and there is a public doc change I wanted to provide the option to merge this right away.


Most operating systems don't have adequate support for giving threads arbitrary names. On such systems the \texttt{TRACY\_COLLECT\_THREAD\_NAMES} macro will be defined, which enables storage of thread names in a lock-free list. On subsequent thread name queries this list is used, instead of the system facilities.

Even if the lock-free list is used, Tracy will also set the thread name using the OS functionality. These names can be then used by debuggers and other external tools.
Copy link
Owner

Choose a reason for hiding this comment

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

This is now always enabled, see 71b54dd. A reword to remove mention of the macro would be better.

@wolfpld wolfpld merged commit 0295ef2 into wolfpld:master Feb 28, 2024
5 checks passed
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.

2 participants