doc update and formatting

Author: tobozo

ReadMe.md

@@ -7,19 +7,22 @@
 Coding Horror
 -------------
 
-This is a very early version of ESP32-PsRamFS: a wannabee RamDisk library for Arduino-ESP32
-with vfs compliance.
+ESP32-PsRamFS id a pseudo RamDisk library for Arduino-ESP32, with vfs compliance.
 
-It provides a `fs::FS` style filesystem using the psram of a ESP32-Wrover or any ESP32
-equipped with PSRam.
+It provides a `fs::FS` style filesystem using the psram of an ESP32-Wrover or any ESP32 equipped with PSRam.
 
-Some unit tests are available in the example folder, consider setting the debug output level to DEBUG to see what's happening.
+Some unit tests are available in the example folder, consider setting the debug output level
+to DEBUG to see what's happening.
 
 Directory support is still partial but the API is now vfs compliant.
 
 Usage
 -----
 
+Only use this if your situation *requires* a filesystem, otherwise consider dropping the
+filesystem and use Streams instead with the excellent [arduino-BufferStream](https://github.com/IndustrialShields/arduino-BufferStream) library.
+
+
 ```C
 
 #include <PSRamFS.h>
@@ -49,7 +52,7 @@ Hardware Requirements:
 Actually PSRam is optional, but strongly recommended.
 
 For very low memory situations that still require some abstraction to access file data,
-consider dropping the filesystem and use Streams instead with the excellent [arduino-BufferStream](https://github.com/IndustrialShields/arduino-BufferStream) library.
+
 
 
 Tested on:

examples/PSRamFS_Test/PSRamFS_Test.ino

@@ -267,7 +267,7 @@ void seekLog( fs::File &file, const char* strref, size_t offset, int mode = 0 )
   size_t index = offset;
   size_t len = strlen(strref);
   if( ! file.seek( index, (fs::SeekMode)mode ) ) {
-    ESP_LOGD(TAG, "Seek call failed at offset %d using mode %d", index, mode );
+    ESP_LOGD(TAG, "Seek call failed at (maybe unrealistic) offset %d using mode %d", index, mode );
     //return;
   }
   char a = file.read();
@@ -331,7 +331,7 @@ void testSeek(fs::FS &fs)
   seekLog( file, message, 0,  2 );  // seek end
   seekLog( file, message, 12, 2 ); // seek end with -12 offset
   // this test is expected to fail, but still set the cursor
-  seekLog( file, message, 12345678, 2 ); // seek end (actually seek start with enormous offset)
+  seekLog( file, message, len*1024, 2 ); // seek end (actually seek start with enormous offset)
 
   int pos = 0;
   file.seek(0);
@@ -356,13 +356,13 @@ void testSeek(fs::FS &fs)
   }
 
 
-  for(int i=0;i<30;i++) {
+  for(int i=0;i<len;i++) {
     size_t random_index = rand()%len;
     char random_char = (rand()%(128-32))+31;
     //ESP_LOGE(TAG, "random char : %s", String(random_char).c_str() );
     file.seek( random_index );
-    file.write( message[random_index] );
-    //message[random_index] = random_char;
+    file.write( random_char/*message[random_index]*/ );
+    message[random_index] = random_char;
     seekLog( file, message, random_index, 2 );
   }
 

src/pfs.c

@@ -548,11 +548,11 @@ size_t pfs_fread( uint8_t *buf, size_t size, size_t count, pfs_file_t * stream )
   }
   memcpy( buf, &stream->bytes[stream->index], to_read );
   if( to_read > 1 ) {
-    ESP_LOGV(TAG, "Reading %d byte(s) at index %d of %d", to_read, stream->index, stream->size );
+    ESP_LOGV(TAG, "(%d, %d) Reading %d byte(s) at index %d of %d", size, count, to_read, stream->index, stream->size );
   } else {
     char out[2] = {0,0};
     out[0] = buf[0];
-    ESP_LOGV(TAG, "Reading %d byte(s) at index %d of %d (%s)", to_read, stream->index, stream->size, out );
+    ESP_LOGV(TAG, "(%d, %d) Reading %d byte(s) at index %d of %d (%s)", size, count, to_read, stream->index, stream->size, out );
   }
   stream->index += to_read;
   return to_read;
@@ -563,11 +563,7 @@ size_t pfs_fread( uint8_t *buf, size_t size, size_t count, pfs_file_t * stream )
 size_t pfs_fwrite( const uint8_t *buf, size_t size, size_t count, pfs_file_t * stream)
 {
   size_t to_write = size*count;
-/*
-  if( stream->size > 0 ) {
-    stream->index = ftell( (FILE*)stream );
-  }
-*/
+
   if( stream->index + to_write >= stream->memsize ) {
 
     size_t used_bytes = pfs_used_bytes();
@@ -602,7 +598,6 @@ size_t pfs_fwrite( const uint8_t *buf, size_t size, size_t count, pfs_file_t * s
   stream->index += to_write;
 
   if (stream->index > stream->size) {
-    ESP_LOGW(TAG, "Flattening stream->size to %d (memsize=%d, should realloc?)", stream->index, stream->memsize );
     stream->size  = stream->index;
   }