KhronosGroup / KhronosGroup/glslang

Reformat code to allow for easier interactive debugging

Open
#2,794 0 comments 1 reaction 0 assignees View on GitHub
enhancement Infrastructure
Dominant language
C++
Stars
3.6k
Forks
989
Avg merge
1d 2h
Merged PRs (30d)
31

Description

https://github.com/KhronosGroup/glslang/issues/2784#issuecomment-952227061_

The heavy use of grouping code onto single lines, as well as single line functions in header files, make interactively debugging GLSLang very difficult. You can't easily see variable values since often breakpoints don't have don't, and stepping into these single lines of code is very difficult.
Personally I find stepping through code to be one of the best ways to learn a new code base, so in with the thought of helping 2784, I'd suggest the codebase be reformatted a bit to help interactive debugging. I'll submit some samples to this issue soon.

Contributor guide

Open the contributing guide

Research direction

Start by reading the referenced comment in issue 2784 and the samples promised in this issue. Identify which GLSLang files and code patterns are in scope, then define completion as a consistent reformat that makes breakpoints and stepping easier without changing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.