# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1582777638 0
# Node ID f44770a652eba3cfb63656b439fb4a4b4e01fd0b
# Parent  dd162a4cb9fac26101750535f2384cbd49a94181
loadtool.help: additional details documented for dump commands

This documentation addition explains the alignment requirements for dump,
dump2bin and dump2srec commands, and explains that dump2srec is deprecated.

diff -r dd162a4cb9fa -r f44770a652eb loadtools/loadtool.help
--- a/loadtools/loadtool.help	Thu Feb 27 01:21:58 2020 +0000
+++ b/loadtools/loadtool.help	Thu Feb 27 04:27:18 2020 +0000
@@ -94,7 +94,9 @@
 
 The first argument is the starting target memory address in hex; the second
 argument is the length of the area to dump, also in hex.  The dump will be
-displayed on the terminal in hex and ASCII.
+displayed on the terminal in hex and ASCII.  As an implementation limit, both
+the starting target memory address and the length of the area to dump need to
+be aligned to 16 bytes.
 
 === dump2bin
 === dump2srec
@@ -105,7 +107,14 @@
 argument is the length of the area to dump, also in hex; the third argument
 is the name of the output file to be created/written.  The dump will be saved
 in binary or S-records as per the chosen command, always in the native byte
-order of the Calypso ARM7 target (little-endian).
+order of the Calypso ARM7 target (little-endian).  As an implementation limit,
+both the starting target memory address and the length of the area to dump need
+to be aligned to 128 bytes.
+
+dump2srec is deprecated, please use dump2bin instead.  If you do use dump2srec,
+the S-record image will be written with 128 bytes of payload per record (270
+ASCII characters per line), which is significantly longer records than most
+SREC conventions.
 
 === exec
 exec <script-file>