doc: more explanation for flashing command

1a7e5bd4 · Alessandro Rubini · 05ac21b5 · 1a7e5bd4
Commit 1a7e5bd4 authored Aug 06, 2012 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 9 additions and 3 deletions

wrs-build.in doc/wrs-build.in +9 -3

No files found.
--- a/doc/wrs-build.in
+++ b/doc/wrs-build.in
@@ -534,14 +534,20 @@ we inherited from Atmel. The @file{flash-wrs} script is what
 you'll use to run the loader with appropriate parameters.

 The script can be invoked in the following way to flash a
- package@footnote{read
-@ref{Release Package} to understand how to create a package.} into
-the switch:
+@i{package} into the switch. To the package is the @code{.tar.gz}
+file created by ``@code{wrs_build-all --pack}'' (see @ref{Release Package}).
+
+The command to flash is this:

 @example
    /path/to/wr-switch-sw/build/flash-wrs -e wrs-firmware-<revision>.tar.gz 
 @end example

+Please note that the ``@code{-e}'', which requires erasing the
+whole flash, is mandatory because otherwise bits of your previous filesystem
+may leak into the newly-programmed one. Only on factory-new devices you
+can avoid this ``@code{-e}'' argument.
+
 The process calls the flasher program twice (so you'll see the
 initialization strings two times) an takes around 3 minutes.
 This is the a summary of the output you are expected to see,