yaffs More tests
[yaffs2.git] / direct / python / README_yaffs_import_py.txt
index d497819..fa9140e 100644 (file)
@@ -1,4 +1,5 @@
 Readme for the yaffs_import.py file
+by Timothy Manning <timothy@yaffs.net> 2010
 
 python yaffs_import [scanning_path] [optional flags]
 
@@ -9,11 +10,11 @@ directories above this path and copy the all files in these directories.
 example:
        $  yaffs_importer.py /home/timothy/work/yaffs/
 
+yaffs_import.py must be run in yaffs/direct/python/ directory.
 
 flags:
        -d [number] 
                set the debugging message level.
-               that debug level 0 will always be printed unless debug_level is set to -1
                level 0 error messages
                level 1 basic tasks are shown(creating, deleating,ect)(this is set as the
                default and is recommended)
@@ -22,15 +23,31 @@ flags:
                level 4 is used for bug hunting and shows each step and in detail 
        -ignore_hidden_directories
                will not copy hidden (./) directories if used.
+       
+       -o [yaffs_path]
+               chooses the path where the branch will be copyied into yaffs.
+               note this path must start with "/yaffs2/" 
+               example: python yaffs_importer.py /home/timothy/work/yaffs/yaffs_importer_test_dir -o /yaffs2/apple/
 
-Deleating files and folders
+       -yaffs_trace [number]
+               this sets the yaffs_trace() function with the number inputed.
+               this number must be in the range of char.
+               yaffs_importer saves the current yaffs_trace value and restores the value after the branch has been imported.
+               setting this flag to -1 will run yaffs_importer with the default yaffs_trace value.  
+
+Deleting files and folders
        to deleate files and folders in yaffs use the yaffs_browser (the documentation still needs to be written).
        to run the browser use this: "python yaffs_browser"
        to deleate a file or a folder select the file or folder then go
        Edit->Delete selected.
 
 Clear Yaffs
-       the easiest way to clear yaffs of all files and folders is to remove
+       the easiest way to clear the yaffs file system of all files and folders is to remove
        the emfile-2k-0 file. this file is stored in the
        yaffs2/direct/python/ folder. 
-       the command is: rm emfile-2k-0  
\ No newline at end of file
+       the command is: rm emfile-2k-0  
+
+TODO list 
+       Add fix the problem of yaffs_write() returning -1 when the disk is full.(generate a error message)
+       Add a yaffs error code refrence (prints a text message about the error)  
+