summaryrefslogtreecommitdiff
path: root/types
diff options
context:
space:
mode:
authorSunil Nimmagadda <sunil@nimmagadda.net>2026-10-24 15:57:39 +0530
committerSunil Nimmagadda <sunil@nimmagadda.net>2026-10-24 15:57:39 +0530
commitbe5b2da8fc3a09238e90deec7e35c40afbe00bd2 (patch)
tree2024e093f590e3cd684d6295dbe0d4b255d72d84 /types
parent5eece24768c35409fe2a48558386f10294f1a700 (diff)
Provide some hover documentation.
Diffstat (limited to 'types')
-rw-r--r--types/elf.d.lua15
1 files changed, 15 insertions, 0 deletions
diff --git a/types/elf.d.lua b/types/elf.d.lua
index 490e262..5e367b1 100644
--- a/types/elf.d.lua
+++ b/types/elf.d.lua
@@ -12,9 +12,24 @@ SegmentType = elf.SegmentType
SegmentFlags = elf.SegmentFlags
ELFVERSION = elf.VERSION
+---ELF header
+--[[
+
+There can be only one header per configuration file.
+class, data, type and machine are mandatory fields while
+the remaining fields are assigned defaults or computed after layout.
+]]
---@param hdr Header
function header(hdr) end
+---ELF program header entries.
+--[[
+
+The program headers are derived from these segment entries.
+type field is mandatory and rest of fields are assigned defaults
+or computed after layout.A segment describes either a range of sections
+or a raw mapping. Do not mix the two forms.
+]]
---@param xs Segment[]
function segments(xs) end