add include support to stm25p volume files

[tinyos-2.x.git] / tools / tinyos / misc / tos-storage-at45db.1

diff --git a/tools/tinyos/misc/tos-storage-at45db.1 b/tools/tinyos/misc/tos-storage-at45db.1
index d511989d6ca4fe9585c31a14ca4bf48b63de385a..48444d905189b68646b57411461ae5aea38a6650 100644 (file)
--- a/tools/tinyos/misc/tos-storage-at45db.1
+++ b/tools/tinyos/misc/tos-storage-at45db.1
@@ -5,7 +5,7 @@
 tos-storage-at45db - Generate storage volume description code
 .SH SYNOPSIS
 
-\fBtos-storage-at45db\fR
+\fBtos-storage-at45db\fR \fIplatform-directory\fR
 .SH DESCRIPTION
 
 \fBtos-storage-at45db\fR reads a user specification describing the layout
@@ -14,11 +14,16 @@ describing that layout for use by the TinyOS 2.0 storage subsystem.  The
 user specification is in XML and is read from standard input. The code is
 written to standard output.
 
+The argument should specify the platform directory for the current
+compilation target; this is necessary for the correct handling of 
+file include statements in the XML input.
+
 This program is normally invoked automatically by the TinyOS build system
 when your application directory contains a \fBvolumes-at45db.xml\fR file.
 .SH EXAMPLES
 
-  tos-storage-at45db <volumes-at45db.xml >build/mica2/StorageVolumes.h
+  tos-storage-at45db /opt/tinyos-2.x/tos/platforms/mica2 \\
+      <volumes-at45db.xml >build/mica2/StorageVolumes.h
 .SH SEE ALSO
 
 .IR tos-storage-stm25p (1)