direct/python/README_yaffs_import_py.txt

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