From 58216abadab96197eb44b0d9ec5a761d74f53324 Mon Sep 17 00:00:00 2001 From: Eduardo Cavazos Date: Wed, 12 Mar 2008 15:41:02 -0600 Subject: [PATCH] core/io/files/files-docs: Add some help for file-info --- core/io/files/files-docs.factor | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/core/io/files/files-docs.factor b/core/io/files/files-docs.factor index 625934e7af..1ff972b505 100755 --- a/core/io/files/files-docs.factor +++ b/core/io/files/files-docs.factor @@ -44,6 +44,8 @@ ARTICLE: "directories" "Directories" { $subsection make-directories } ; ARTICLE: "fs-meta" "File meta-data" +{ $subsection file-info } +{ $subsection link-info } { $subsection exists? } { $subsection directory? } { $subsection file-length } @@ -114,6 +116,25 @@ HELP: file-name { $example "USING: io.files prettyprint ;" "\"/usr/libexec/awk/\" file-name ." "\"awk\"" } } ; +! need a $class-description file-info + +HELP: file-info + { $values { "path" "a pathname string" } + { "info" "a file-info tuple" } } + { $description "Queries the file system for meta data. " + "If path refers to a symbolic link, it is followed." + "If the file does not exist, an exception is thrown." } ; +! need a see also to link-info + +HELP: link-info + { $values { "path" "a pathname string" } + { "info" "a file-info tuple" } } + { $description "Queries the file system for meta data. " + "If path refers to a symbolic link, information about " + "the symbolic link itself is returned." + "If the file does not exist, an exception is thrown." } ; +! need a see also to file-info + HELP: { $values { "path" "a pathname string" } { "encoding" "an encoding descriptor" { "stream" "an input stream" } } { "stream" "an input stream" } }