]> gitweb.factorcode.org Git - factor.git/blobdiff - core/io/pathnames/pathnames-docs.factor
Fix conflict
[factor.git] / core / io / pathnames / pathnames-docs.factor
index 2400faecd27ecb9dd52beda49dd488d6f85f4204..733283d2982f791d40dda509a735ee71b0722687 100644 (file)
@@ -1,4 +1,5 @@
-USING: help.markup help.syntax io.backend io.files io.directories strings ;
+USING: help.markup help.syntax io.backend io.files io.directories strings
+sequences ;
 IN: io.pathnames
 
 HELP: path-separator?
@@ -22,6 +23,10 @@ HELP: file-name
     { $example "USING: io.pathnames prettyprint ;" "\"/usr/libexec/awk/\" file-name ." "\"awk\"" }
 } ;
 
+HELP: path-components
+{ $values { "path" "a pathnames string" } { "seq" sequence } }
+{ $description "Splits a pathname on the " { $link path-separator } " into its its component strings." } ;
+
 HELP: append-path
 { $values { "str1" "a string" } { "str2" "a string" } { "str" "a string" } }
 { $description "Appends " { $snippet "str1" } " and " { $snippet "str2" } " to form a pathname." } ;
@@ -65,6 +70,10 @@ HELP: normalize-path
   }
 } ;
 
+HELP: canonicalize-path
+{ $values { "path" "a pathname string" } { "path'" "a new pathname string" } }
+{ $description "Returns an canonical name for a path. The canonical name is an absolute path containing no symlinks." } ;
+
 HELP: <pathname>
 { $values { "string" "a pathname string" } { "pathname" pathname } }
 { $description "Creates a new " { $link pathname } "." } ;
@@ -78,7 +87,10 @@ ARTICLE: "io.pathnames" "Pathname manipulation"
 { $subsection parent-directory }
 { $subsection file-name }
 { $subsection last-path-separator }
+{ $subsection path-components }
+{ $subsection prepend-path }
 { $subsection append-path }
+{ $subsection canonicalize-path }
 "Pathname presentations:"
 { $subsection pathname }
 { $subsection <pathname> }