suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix return documentation for tar' and tar->output'

Browse Source 
Add documentation for `tar-gzip'

svn: r14235
This commit is contained in:
Sam Tobin-Hochstadt 2009-03-23 15:54:26 +00:00
parent 746446d4ac
commit ba56d99adb
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
collects/file/scribblings/tar.scrbl
View File

@ -1,6 +1,6 @@
#lang scribble/doc #lang scribble/doc
@(require "common.ss" @(require "common.ss"
(for-label file/tar)) (for-label file/tar file/gzip))
@title[#:tag "tar"]{@exec{tar} File Creation} @title[#:tag "tar"]{@exec{tar} File Creation}
@ -13,7 +13,7 @@ information is not preserved; the owner that is stored in the archive
is always ``root.''} is always ``root.''}
@defproc[(tar [tar-file path-string?][path path-string?] ...) @defproc[(tar [tar-file path-string?][path path-string?] ...)
void?]{ exact-nonnegative-integer?]{
Creates @scheme[tar-file], which holds the complete content of all Creates @scheme[tar-file], which holds the complete content of all
@scheme[path]s. The given @scheme[path]s are all expected to be @scheme[path]s. The given @scheme[path]s are all expected to be
@ -23,12 +23,18 @@ to the current directory). If a nested path is provided as a
resulting tar file, up to the current directory (using resulting tar file, up to the current directory (using
@scheme[pathlist-closure]).} @scheme[pathlist-closure]).}
@defproc[(tar->output [paths (listof path-string?)] @defproc[(tar->output [paths (listof path?)]
[out output-port? (current-output-port)]) [out output-port? (current-output-port)])
void?]{ exact-nonnegative-integer?]{
Packages each of the given @scheme[paths] in a @exec{tar} format Packages each of the given @scheme[paths] in a @exec{tar} format
archive that is written directly to the @scheme[out]. The specified archive that is written directly to the @scheme[out]. The specified
@scheme[paths] are included as-is; if a directory is specified, its @scheme[paths] are included as-is; if a directory is specified, its
content is not automatically added, and nested directories are added content is not automatically added, and nested directories are added
without parent directories.} without parent directories.}
@defproc[(tar-gzip [tar-file path-string?] [paths path-string?] ...)
void?]{
Like @scheme[tar], but compresses the resulting file with @scheme[gzip].
}