include: Add reference URLs in elf/amdgpu.h
Adds URLs to elf/amdgpu.h to clarify the source of AMDGPU ELF header constants.
This patch adds reference URLs to the elf/amdgpu.h header file, which defines constants related to AMDGPU ELF headers. The URLs point to the AMDGPU documentation, clarifying the origin and meaning of these constants. This improves code maintainability and makes it easier for developers to understand the AMDGPU-specific ELF structures.
- proposer
Proposes adding reference URLs to the AMDGPU header file to clarify the source of the constants.
“During review, a question was "where are those numbers that you are adding defined". Add some URLs pointing to the source of truth for those numbers.”
In Details
This patch enhances the elf/amdgpu.h header with URLs pointing to the AMDGPU documentation. This header defines AMDGPU-specific ELF constants used by binutils components like readelf to interpret AMDGPU code objects.
For Context
This patch improves the documentation of AMDGPU-specific definitions within the binutils source code. Specifically, it adds URLs to the elf/amdgpu.h header file, which defines constants related to the structure of AMDGPU ELF files. By providing direct links to the relevant AMDGPU documentation, this change makes the code easier to understand and maintain.