asm_book/section_1
Perry Kivolowitz 88c8f496c4 Document hex dump display convention in alignment chapter
Closes #22.

The alignment chapter's hex dump examples (e.g. "0011 eeff ccdd aabb"
for a little-endian long initialized to 0xaabbccddeeff0011) are correct
under the default hexdump(1) output convention: bytes grouped into
16-bit little-endian words, each word printed most-significant byte
first. But the chapter never told the reader which convention was in
use, so a reader reproducing the example with xxd or hexdump -C (both
byte-oriented, showing raw memory order) would get a different-looking
result and conclude the book had an endianness bug. That is exactly
what issue #22 reported, and it is also part of what the #33 filer
flagged as "there are no instructions about how to do such a thing"
for hex dumps in this chapter.

Fix: one new subsection "A Note on Hex Dumps" placed before Example 1,
stating the convention explicitly and warning xxd / hexdump -C users
that the bytes within each pair will appear swapped relative to the
examples. The examples themselves are unchanged; they were already
self-consistent under the word-oriented convention.

Rejected alternative: rewriting all the examples in byte-oriented
(xxd) form. That would have matched what most modern readers reach
for, but would also have required regenerating every hex dump in the
chapter and losing continuity with any reader who already absorbed
the current notation. A single explanatory paragraph is less invasive
and teaches the distinction, which is useful in its own right.

No test coverage applies; this is prose.
2026-04-19 02:20:10 -05:00
..
const updated markdownlint problems plus error in while 2024-01-25 16:08:01 -06:00
fizzbuzz updated markdownlint problems plus error in while 2024-01-25 16:08:01 -06:00
for updated markdownlint problems plus error in while 2024-01-25 16:08:01 -06:00
funcs removed link for Jishnu as it turned into a gambling sitegit add . 2025-01-14 20:40:56 -06:00
hello_world incorporated gitonthescene feedback 2024-07-04 12:32:47 -05:00
if corrected broken link for register interlude. 2025-01-14 20:51:02 -06:00
jump_tables updated PDFs 2023-01-18 08:26:45 -06:00
recursion updated markdownlint problems plus error in while 2024-01-25 16:08:01 -06:00
regs corrected a link 2024-05-03 18:53:46 -05:00
structs Document hex dump display convention in alignment chapter 2026-04-19 02:20:10 -05:00
while corrected sense of compare for error filed almost one year ago and in a different life 2025-01-14 20:56:13 -06:00
hex.md Os are not 0s. 2023-02-01 08:09:36 -06:00
hex.pdf do not write while sleeping 2023-02-01 08:06:31 -06:00
kickstart.md something changed 2024-02-17 16:17:36 -06:00
kickstart.pdf something changed 2024-02-17 16:17:36 -06:00