4f93cc401fb0968ca043268ac94fda4421807ace
[yaffs2.git] / direct / python / README_yaffs_import_py.txt
1 Readme for the yaffs_import.py file
2
3 python yaffs_import [scanning_path] [optional flags]
4
5 the scanning path needs to be the absolute path to the directory where you
6 wish to start scanning from. this function will scan all of the the
7 directories above this path and copy the all files in these directories.
8
9 example:
10         $  yaffs_importer.py /home/timothy/work/yaffs/
11
12
13 flags:
14         -d [number] 
15                 set the debugging message level.
16                 level 0 error messages
17                 level 1 basic tasks are shown(creating, deleating,ect)(this is set as the
18                 default and is recommended)
19                 level 2 all process are shown
20                 level 3 shows minor tasks such as join_paths, ect
21                 level 4 is used for bug hunting and shows each step and in detail 
22         -ignore_hidden_directories
23                 will not copy hidden (./) directories if used.
24         
25         -o [yaffs_path]
26                 chooses the path where the branch will be copyied into yaffs.
27                 note this path must start with "/yaffs2/" 
28                 example: python yaffs_importer.py /home/timothy/work/yaffs/yaffs_importer_test_dir -o /yaffs2/apple/
29
30         -yaffs_trace [number]
31                 this sets the yaffs_trace() function with the number inputed.
32                 this number must be in the range of char.
33                 yaffs_importer saves the current yaffs_trace value and restores the value after the branch has been imported.
34                 setting this flag to -1 will run yaffs_importer with the default yaffs_trace value.  
35
36 Deleting files and folders
37         to deleate files and folders in yaffs use the yaffs_browser (the documentation still needs to be written).
38         to run the browser use this: "python yaffs_browser"
39         to deleate a file or a folder select the file or folder then go
40         Edit->Delete selected.
41
42 Clear Yaffs
43         the easiest way to clear the yaffs file system of all files and folders is to remove
44         the emfile-2k-0 file. this file is stored in the
45         yaffs2/direct/python/ folder. 
46         the command is: rm emfile-2k-0