aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-21 14:23:35 +01:00
parent f53092c941
commit 55b688c522
109 changed files with 6592 additions and 6502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/html/structDumpHardwareEntriesWithData.html
View File

@@ -125,7 +125,7 @@ Data Fields</h2></td></tr>
<div class="textblock"><p>In-memory representation of a dump hardware entry plus decoded variable-length fields &amp; extents. </p>
<p>All string pointers are NUL-terminated UTF-8 copies of on-disk data (or NULL if absent). extents array may be NULL when no ranges were recorded. Freed during context teardown. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00313">313</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00314">314</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a9b5f7b438c99ede6988179b7b89915df" name="a9b5f7b438c99ede6988179b7b89915df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b5f7b438c99ede6988179b7b89915df">&#9670;&#160;</a></span>entry</h2>
@@ -141,9 +141,9 @@ Data Fields</h2></td></tr>
<p>Fixed-size header with lengths &amp; counts. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00315">315</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00316">316</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -161,9 +161,9 @@ Data Fields</h2></td></tr>
<p>Array of extents (entry.extents elements) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00316">316</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00317">317</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -181,9 +181,9 @@ Data Fields</h2></td></tr>
<p>Firmware version string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00320">320</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00321">321</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -201,9 +201,9 @@ Data Fields</h2></td></tr>
<p>Manufacturer string (UTF-8) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00317">317</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00318">318</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -221,9 +221,9 @@ Data Fields</h2></td></tr>
<p>Model string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00318">318</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00319">319</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -241,9 +241,9 @@ Data Fields</h2></td></tr>
<p>Hardware revision string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00319">319</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00320">320</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -261,9 +261,9 @@ Data Fields</h2></td></tr>
<p>Serial number string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00321">321</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00322">322</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -281,9 +281,9 @@ Data Fields</h2></td></tr>
<p>Dump software name or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00322">322</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00323">323</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -301,9 +301,9 @@ Data Fields</h2></td></tr>
<p>Host operating system string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00324">324</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00325">325</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -321,9 +321,9 @@ Data Fields</h2></td></tr>
<p>Dump software version or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00323">323</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00324">324</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>