changeset 2524:8db3f8136a70

* doc/mk_romfs.txt (Usage): Remove documentation about obsolete CYGNUM_FS_ROM_BASE_ADDRESS option, and replace with better usage description.
author jlarmour
date Thu, 14 Aug 2008 20:10:52 +0000
parents 41caa79fe76e
children 33cc410733a0
files packages/fs/rom/current/ChangeLog packages/fs/rom/current/doc/mk_romfs.txt
diffstat 2 files changed, 27 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/packages/fs/rom/current/ChangeLog
+++ b/packages/fs/rom/current/ChangeLog
@@ -1,3 +1,10 @@
+2008-08-14  Klaas Gadeyne  <klaas.gadeyne@fmtc.be>
+2008-08-14  Jonathan Larmour  <jifl@eCosCentric.com>
+
+	* doc/mk_romfs.txt (Usage): Remove documentation about obsolete
+	CYGNUM_FS_ROM_BASE_ADDRESS option, and replace with better
+	usage description.
+
 2006-11-13 Xinghua Yang <yxinghua@sunnorth.com.cn>
            Taiyun  Wang <taiyun@sunnorth.com.cn>
 
--- a/packages/fs/rom/current/doc/mk_romfs.txt
+++ b/packages/fs/rom/current/doc/mk_romfs.txt
@@ -88,7 +88,24 @@ 5. Copy the image from RAM to ROM...
 	RedBoot>
 
 6. MAKE A NOTE OF THE ADDRESS IN FLASH THAT THE IMAGE IS LOADED AT.
-   The ROMFS option 'CYGNUM_FS_ROM_BASE_ADDRESS' needs to be set to this
-   value in order to access the filesystem.
-  
+
+   This address can then be used in your program in order to mount the
+   filesystem.
+
+   For example, to automatically mount the new romfs created above at
+   /rom, you can use the following macro in your application:
 
+       MTAB_ENTRY( romfs_mte1,
+                   "/rom",
+                   "romfs",
+                   "",
+                   (CYG_ADDRWORD) 0x50040000 );
+
+   See the File I/O package documentation in the eCos Reference Manual
+   ("Writing a New Filesystem") for more information about the MTAB_ENTRY
+   macro.
+
+   Alternatively, the filesystem can be dynamically mounted with a call
+   to mount() such as the following:
+
+     err = mount( "0x50040000", "/rom", "romfs" );