[cadcdev-svn-commits] [SCM] branch master updated. v2.0.0-1482-g2751f20f

[falcovorbis <fal...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "A pseudo Operating System for the Dreamcast.".

The branch, master has been updated
       via  2751f20f40083c856e767b90eff4c64206987b68 (commit)
      from  002de35db2462e7d2d78713b2a954ff2d0c8a756 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 2751f20f40083c856e767b90eff4c64206987b68
Author: José Ribeiro <602...@us...>
Date:   Sun Aug 11 16:36:21 2024 +0100

    Expanded VFS documentation (#684)
    
    * Reworking FS driver explanation and size warning
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Andy Barajas <and...@gm...>
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Andy Barajas <and...@gm...>
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Andy Barajas <and...@gm...>
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Andy Barajas <and...@gm...>
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Falco Girgis <gyr...@gm...>
    
    * Explain how to build and embed fs image
    
    * Rewworking the line sizes
    
    * Update include/kos/fs_romdisk.h
    
    Co-authored-by: Falco Girgis <gyr...@gm...>
    
    ---------
    
    Co-authored-by: Andy Barajas <and...@gm...>
    Co-authored-by: Falco Girgis <gyr...@gm...>

-----------------------------------------------------------------------

Summary of changes:
 include/kos/fs_romdisk.h | 30 +++++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/include/kos/fs_romdisk.h b/include/kos/fs_romdisk.h
index c322bbb5..274d00a5 100644
--- a/include/kos/fs_romdisk.h
+++ b/include/kos/fs_romdisk.h
@@ -15,9 +15,33 @@
     with the genromfs program that is included in the utils portion of the tree.
 
     You can choose to automount one ROMFS image by embedding it into your binary
-    and using the appropriate KOS_INIT_FLAGS() setting. The embedded ROMFS will
-    mount itself on /rd. You can also mount additional images that you load
-    from some other source on whatever mountpoint you want.
+    and using the appropriate flags (INIT_DEFAULT by itself or INIT_FS_ROMDISK with other flags)
+    when calling the KOS_INIT_FLAGS() macro with a custom flag selection. The embedded ROMFS
+    will mount itself on /rd.
+
+    \warning
+    An embedded romdisk image is linked to your executable and cannot be evicted from
+    system RAM!
+    
+    Mounting additional images that you load from some other sources (such as a modified BIOS)
+    on whatever mountpoint you want, is also possible. Using fs_romdisk_mount() and passing a
+    pointer to the location of a romdisk image will mount it.
+
+    \remark 
+    Mounted images will reside in system RAM for as long as your program is running
+    or until you unmount them with fs_romdisk_unmount(). The size of your generated
+    ROMFS image must be kept below 16MB, with 14MB being the maximum recommended size, 
+    as your binary will also reside in RAM and you need to leave some memory available
+    for it. Generating files larger than the available RAM will lead to system crashes.
+    
+    A romdisk filesystem image can be created by adding "KOS_ROMDISK_DIR=" to your Makefile
+    and pointing it to the directory contaning all the resources you wish to have embeded in
+    filesystem image. A rule to create the image is provided in the rules provided in Makefile.rules,
+    the created object file must be linked with your binary file by adding romdisk.o to your 
+    list of objects.
+    
+    \see INIT_FS_ROMDISK
+    \see KOS_INIT_FLAGS()
 
     \author Megan Potter
 */


hooks/post-receive
-- 
A pseudo Operating System for the Dreamcast.