microsoft / microsoft/DirectXShaderCompiler
packoffset documentation is incorrect
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 3.7k
- Forks
- 900
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 44
Description
Description
There is incorrect information in the packoffset documentation:
https://learn.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-variable-syntax
https://learn.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl-variable-packoffset
Since this behavior was addressed in: https://github.com/microsoft/DirectXShaderCompiler/issues/3724
Update the documentation to represent the actual compiler behavior
Steps to Reproduce
Read the documentation, then observe that that is not the compiler behavior
Actual Behavior
The compiler errors when the documentation states it will not
Environment
- DXC version: 1.8.2405
- Host Operating System: All
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the two linked packoffset documentation pages with the behavior described in issue 3724 and the DXC 1.8.2405 behavior noted here. Update the documentation so its stated compiler behavior matches the actual error, then verify that the affected statements are no longer contradictory.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100