basis/io/directories/hierarchy/hierarchy-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: io.directories.hierarchy
   3
   4 HELP: delete-tree
   5 { $values { "path" "a pathname string" } }
   6 { $description "Deletes a file or directory, recursing into subdirectories." }
   7 { $errors "Throws an error if the deletion fails." }
   8 { $warning "Misuse of this word can lead to catastrophic data loss." } ;
   9
  10 HELP: copy-tree
  11 { $values { "from" "a pathname string" } { "to" "a pathname string" } }
  12 { $description "Copies a directory tree recursively." }
  13 { $notes "This operation attempts to preserve original file attributes, however not all attributes may be preserved." }
  14 { $errors "Throws an error if the copy operation fails." } ;
  15
  16 HELP: copy-tree-into
  17 { $values { "from" "a pathname string" } { "to" "a directory pathname string" } }
  18 { $description "Copies a directory tree to another directory, recursively." }
  19 { $errors "Throws an error if the copy operation fails." } ;
  20
  21 HELP: copy-trees-into
  22 { $values { "files" "a sequence of pathname strings" } { "to" "a directory pathname string" } }
  23 { $description "Copies a set of directory trees to another directory, recursively." }
  24 { $errors "Throws an error if the copy operation fails." } ;
  25
  26 ARTICLE: "io.directories.hierarchy" "Directory hierarchy manipulation"
  27 "The " { $vocab-link "io.directories.hierarchy" } " vocabulary defines words for operating on directory hierarchies recursively."
  28 $nl
  29 "Deleting directory trees recursively:"
  30 { $subsections delete-tree }
  31 "Copying directory trees recursively:"
  32 { $subsections
  33     copy-tree
  34     copy-tree-into
  35     copy-trees-into
  36 } ;
  37
  38 ABOUT: "io.directories.hierarchy"