Fixed printf formatting.

[lwext4.git] / readme.mediawiki

diff --git a/readme.mediawiki b/readme.mediawiki
index 37fec5a0b5141434ab5ce76973da72eea3a7bc93..316966920f2ef8ba067f6f0dfe529aa14ca3f737 100644 (file)
--- a/readme.mediawiki
+++ b/readme.mediawiki
@@ -1,4 +1,4 @@
-==About lwext4==\r
+==About==\r
 \r
 The main goal of the lwext4 project is to provide ext2/3/4 filesystem\r
 library for microcontrolers with SD/MMC card support. Ext2/3/4, in my\r
@@ -13,7 +13,7 @@ kostka.grzegorz@gmail.com
 =====RAM:=====\r
  - 8KB\r
 =====STACK:=====\r
- - 1KB-2KB (not tested yet)\r
+ - 2KB\r
 \r
 \r
 ==ext2/3/4 vs FAT32==\r
@@ -26,14 +26,14 @@ kostka.grzegorz@gmail.com
 ;ext2/3/4 < FAT32\r
 * FAT32 has smaller footprint\r
 \r
-==Credits lwext4==\r
+==Credits==\r
 \r
 A lot of the implementation of lwext4 was taken from HelenOS:\r
     http://helenos.org/\r
  \r
 Some of ideas and features are based on FreeBSD and Linux implementations.\r
 \r
-==lwext4 supported/unsupported ext2/3/4 fs features==\r
+==Supported ext2/3/4 fs features==\r
 \r
 ;FEATURE_INCOMPAT (unable to mount with unsupported feature):\r
  COMPRESSION: no\r
@@ -48,7 +48,7 @@ Some of ideas and features are based on FreeBSD and Linux implementations.
  EA_INODE:    no\r
  DIRDATA:     no\r
  \r
-;FEATURE_INCOMPAT (able to mount with unsupported feature):\r
+;FEATURE_COMPAT (able to mount with unsupported feature):\r
  DIR_PREALLOC:   no\r
  IMAGIC_INODES:  no\r
  HAS_JOURNAL:    no\r
@@ -56,7 +56,7 @@ Some of ideas and features are based on FreeBSD and Linux implementations.
  RESIZE_INODE:   no\r
  DIR_INDEX:      yes\r
 \r
-;FEATURE_RO (able to mount in read only with unsupported feature):\r
+;FEATURE_RO (able to mount in read only mode):\r
  SPARSE_SUPER:  yes\r
  LARGE_FILE:    yes\r
  BTREE_DIR:     no\r
@@ -74,12 +74,12 @@ Some of ideas and features are based on FreeBSD and Linux implementations.
  SOFTLINK:  no\r
  SOCKET:    no\r
 \r
-==Other:==\r
+==Other==\r
  - block_size: 1KB, 2KB, 4KB ... 64KB\r
  - little/big endian architecture support\r
 \r
 \r
-==lwext4 project tree==\r
+==Project tree==\r
 \r
  - blockdev         - block devices set, supported blockdevs\r
  -- filedev         - file based block device\r
@@ -95,10 +95,11 @@ Some of ideas and features are based on FreeBSD and Linux implementations.
  - ext4.h           - lwext4 client library header\r
  - CMakeLists.txt   - CMake config file\r
  - ext_images.7z    - ext2/3/4 100MB images\r
+ - fs_test.mk       - automatic tests definition\r
  - Makefile         - helper makefile to call cmake\r
  - readme.mediawiki - yes, you are here ;)\r
   \r
-==lwext4 compile Windows==\r
+==Compile: Windows==\r
 ;Tools needed:\r
 * CMake:  http://www.cmake.org/cmake/resources/software.html\r
 * MinGw:  http://www.mingw.org/\r
@@ -114,7 +115,7 @@ Some of ideas and features are based on FreeBSD and Linux implementations.
  cd build_generic\r
  make\r
 \r
-==lwext4 compile Linux==\r
+==Compile: Linux==\r
 \r
 Tools needed:\r
  - CMake:  http://www.cmake.org/cmake/resources/software.html\r
@@ -129,7 +130,7 @@ Tools needed:
  cd build_generic\r
  make\r
 \r
-==lwext4 generic demo app==\r
+==Generic demo application==\r
 \r
 Features:\r
  - load ext2/3/4 images\r
@@ -162,25 +163,70 @@ Usage:
     --sbstat - superblock stats                                 \r
     --wpart  - windows partition mode                           \r
 \r
+==Client-server automatic test suite==\r
 \r
-==lwext4 compile Cross==\r
+Build:\r
+ make\r
+ cd build_generic\r
+ make\r
+ \r
+Unpack images:\r
+ make unpack_images\r
+ \r
+Run server:\r
+ make server_ext2\r
+ \r
+Run tests:\r
+ make all_tests\r
 \r
-Toolchain for ARM Cortex-m3/4: https://launchpad.net/gcc-arm-embedded\r
-Toolchain for Blackfin: http://blackfin.uclinux.org/doku.php\r
 \r
-Build bf158 library:\r
- make bf518\r
+==Cross-Compile==\r
 \r
+ Toolchain for ARM Cortex-m3/4: https://launchpad.net/gcc-arm-embedded\r
+ Toolchain for Blackfin: http://blackfin.uclinux.org/doku.php\r
+\r
+Build bf518 library:\r
+ make bf518\r
+ cd build_bf518\r
+ make lwext4\r
+ \r
 Build cortex-m3 library:\r
  make cortex-m3\r
+ cd build_cortex-m3\r
+ make lwext4\r
 \r
 Build cortex-m4 library:\r
  make cortex-m4\r
+ cd build_cortex-m4\r
+ make lwext4\r
 \r
-==lwext4 ports==\r
- -Blackfin BF518 EZKIT SD Card Demo: TBD\r
- -STM32F4-Discovery SD Card Demo: TBD \r
-\r
-==lwext4 footprint==\r
-                           \r
-TBD
\ No newline at end of file
+==Ports==\r
+STM32F429-DISCO USB flash drive Demo \r
+ \r
+Build STM32F429 Demo:\r
+ make cortex-m4\r
+ cd build_cortex-m4\r
+ make all\r
+\r
+==Footprint==\r
+\r
+ TOOLCHAIN: arm-none-eabi-gcc\r
+ OPT: Os  \r
+ OUTPUT:\r
+   text    data     bss     dec     hex filename\r
+   5728       0       0    5728    1660 ext4.c.obj (ex liblwext4.a)\r
+   2264       0       0    2264     8d8 ext4_balloc.c.obj (ex liblwext4.a)\r
+   1324       0       0    1324     52c ext4_bcache.c.obj (ex liblwext4.a)\r
+    936       0       0     936     3a8 ext4_bitmap.c.obj (ex liblwext4.a)\r
+   2016       0       0    2016     7e0 ext4_blockdev.c.obj (ex liblwext4.a)\r
+    624       0       0     624     270 ext4_block_group.c.obj (ex liblwext4.a)\r
+     24       0       4      28      1c ext4_debug.c.obj (ex liblwext4.a)\r
+   2264       0       0    2264     8d8 ext4_dir.c.obj (ex liblwext4.a)\r
+   3204       0       0    3204     c84 ext4_dir_idx.c.obj (ex liblwext4.a)\r
+   3104       0       0    3104     c20 ext4_extent.c.obj (ex liblwext4.a)\r
+   7360       0       0    7360    1cc0 ext4_fs.c.obj (ex liblwext4.a)\r
+   2496       0       0    2496     9c0 ext4_hash.c.obj (ex liblwext4.a)\r
+    684       0       0     684     2ac ext4_ialloc.c.obj (ex liblwext4.a)\r
+    652       0       0     652     28c ext4_inode.c.obj (ex liblwext4.a)\r
+    352       0       0     352     160 ext4_super.c.obj (ex liblwext4.a)                      \r
+                           
\ No newline at end of file