Fork: 0
tundra / tren
Transfer to URL with SHA Find file
Newer
Older
tren / TODO
@tundra tundra on 23 Feb 2010 2 KB Initial revision
Raw Blame History 
  1.  
  2.  
  3. Put explicit length constraints on new target names:
  4.  
  5.     0 < len(name) < some max value
  6.  
  7. Consider making -x interact with -c and -g
  8.  
  9. Check all examples in the doc.
  10.  
  11. Test on Windows and Linux.
  12.  
  13.  
  14. Documentation
  15. -------------
  16.  
  17.  
  18. - Get rid of the toggles and their associated docs having to do with
  19.   resetting options to their default state.  No longer needed now that
  20.   we're not allowing option-target pairs.
  21.  
  22. - -v now continues after displaying results.  This allows it
  23.    to go into log outputs.
  24.  
  25. - Note that multiple items sharing the same sequencing key (ctime,
  26.   size) will be ordered alphabetically within that key.
  27.  
  28. - Change -f description to indicate that it will merely rename (not
  29.   remove) the existing target.
  30.  
  31. - Document -S (Default: ".backup")
  32.  
  33. - Note limit of total new filename length is 255.
  34.  
  35. - Document -w linelength option. Default: 80.  Program determines
  36.   min output length. ONLY for error and info output (which can
  37.   be long).  Ordinary program output like usage and version info
  38.   ignores this.  If capturing for log/analysis, set this very wide.
  39.  
  40. - Get rid of references to option-target pairs.  Note that from the
  41.   first non-option string forward, everything is understood to be
  42.   a filename even if it is in -option format.
  43.  
  44. - Document -R rensep - single char
  45.  
  46. - Document, all the stat-based sequences as well as alpha asc- desc-
  47.  
  48. - Note importance of doing -d last, right before filename args to
  49.   get most current state of prog.
  50.  
  51. - Note that '\' may itself have to be escaped on the shell command line.
  52.  
  53. - Note the -E only applies during renaming operations.  Other errors will
  54.   halt program.
  55.  
  56. - Changed option -1 to -G
  57.  
  58. - -r  =something -> entire target name is replaced by "something"
  59.   -r  something= -> "something" is removed from the target name
  60.  
  61. - Note that twander can be used as a GUI frontend for tren.
  62.  
  63. - Note the use of docutils/resturctured text in producing the docs.
  64.  
  65. - Document -P escape single char.
  66.  
  67. - Changed option -l to -L.
  68.  
  69. - Document overlapping renames:
  70.  
  71.     - Because of overlapping substitutions
  72.  
  73.         Note specific multi-rename semantics disjoint, overlapping, reduced
  74.         string length.
  75.  
  76.     - Because of filename collisions
  77.  
  78.        Note the potential problem of:
  79.  
  80.         Rename: x -> x1 causes existing to be renamed x1.backup
  81.    
  82.         Now a rename of x1 -> z1 still works *but we're renaming a different file* (originally x)
  83.  
  84.         Do this repeatedly and you'll wipe out all but the last file and backup
  85.  
  86. - Backups can be backed up:
  87.  
  88.   foo.backup.backup.backup...
  89.  
  90. - Note that -q clobbers ALL informational output, even during test
  91.   runs: -qt does not make sense
  92.  
  93. - The whole name/extension distinction has been removed.  The eliminates the following options:
  94.  
  95.    -a
  96.    -b
  97.    -e
  98.    -L
  99.