Skip to content

[Enhancement]: Add Debugging Switches Documentation #588

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.

Sign up for GitHub

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

Jump to bottom
Open
bernie-laberge opened this issue Sep 20, 2024 Discussed in #231 · 6 comments
Open

[Enhancement]: Add Debugging Switches Documentation #588

bernie-laberge opened this issue Sep 20, 2024 Discussed in #231 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@bernie-laberge
Copy link
Contributor

Discussed in #231

Originally posted by mikepkes August 9, 2023
The debugging switches have been invaluable for narrowing down issues or understanding behaviors. Making this into both -help and user documentation would help elevate this valuable set of debugging tools.

OpenRV/src/lib/app/RvApp/Options.cpp

Line 64 in 41eccbe

void debugSwitches(const std::string& name)

@bernie-laberge bernie-laberge added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 20, 2024
@cochang-dwa
Copy link
Contributor

I'm interested in working on this for Dev Days!

@cochang-dwa
Copy link
Contributor

Looks like it's already in the -help.

-debug ...              Debuging categories: events, threads, gpu, audio, audioverbose, dumpaudio, shaders, shadercode, profile, playback, playbackverbose, cache, mu, muc, compile, dtree, passes, imagefbo, nogpucache, imagefbolog, nodes, plugins

It's also in the RV User Manual, but perhaps I can add the categories:

OpenRV/docs/rv-manuals/rv-user-manual/rv-user-manual-chapter-three.md

Line 169 in d344142

| -debug *string* | Debug category |

@bernie-laberge
Copy link
Contributor Author

Hello @cochang-dwa !
If you could add the debug switches to the documentation that would be great !
So that one does not have to call RV --help to see the list of debug options but can also look them up in the documentation.

Also, we've noticed that the user manual chapter 13 is not listed correctly. In case you want to fix it as well. :-)

Image

Thanks!

@cochang-dwa
Copy link
Contributor

Thanks @bernie-laberge! Ok, I'll give that a try! I'm not familiar with creating ReadTheDocs. Is it this file? And I should move 13 to between 12 and 14?

OpenRV/docs/index.md

Line 29 in d344142

rv-manuals/rv-user-manual/rv-user-manual-chapter-thirteen

@cochang-dwa
Copy link
Contributor

@bernie-laberge Should I combine the reordering and debug switches in the same PR or separate PRs?

@cochang-dwa cochang-dwa mentioned this issue May 17, 2025
Merged
@bernie-laberge
Copy link
Contributor Author

What you did in your PR is perfect @cochang-dwa. Thanks!

cedrik-fuoco-adsk pushed a commit that referenced this issue May 29, 2025
@cochang-dwa
558: Add Debugging Switches Documentation (#782)
4dbd55c 
### Linked issues
#588

### Summarize your change.
Add the list of possible debug flags to the User Manual, and fixed the
order for chapter 13.

### Describe what you have tested and on which operating system.
Checked docs in VS Code markdown preview

### Add a list of changes, and note any that might need special
attention during the review.
- Add the list of possible debug flags to the User Manual
- Fix the order for chapter 13 in User Manual

---------

Signed-off-by: Connie Chang <connie.chang@dreamworks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bernie-laberge @cochang-dwa