diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2005-01-21 09:17:58 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2005-01-21 09:17:58 (GMT) |
| commit | 59d4795f9bae048885a792b1d68ad392e17c43b5 (patch) | |
| tree | 2ed1d59b7e54af216a399e4a71786c2a319b1774 | |
| parent | 9e6a2e914074f67458109f1ba01fe1d84563d1cc (diff) | |
| download | tcl-59d4795f9bae048885a792b1d68ad392e17c43b5.zip tcl-59d4795f9bae048885a792b1d68ad392e17c43b5.tar.gz tcl-59d4795f9bae048885a792b1d68ad392e17c43b5.tar.bz2 | |
Add documentation for Tcl_FSLink args. [Bug 1106272]
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | doc/FileSystem.3 | 13 |
2 files changed, 17 insertions, 1 deletions
@@ -1,3 +1,8 @@ +2005-01-21 Donal K. Fellows <donal.k.fellows@man.ac.uk> + + * doc/FileSystem.3: Add missing ARGUMENTS section definitions for + arguments to Tcl_FSLink. [Bug 1106272] + 2005-01-19 Donal K. Fellows <donal.k.fellows@man.ac.uk> TIP#235 IMPLEMENTATION diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index 1781a34..abf9780 100644 --- a/doc/FileSystem.3 +++ b/doc/FileSystem.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: FileSystem.3,v 1.50 2004/10/07 15:15:37 dkf Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.51 2005/01/21 09:18:02 dkf Exp $ '\" .so man.macros .TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" @@ -228,6 +228,17 @@ The base path on to which to join the given elements. May be NULL. The number of elements in \fIobjv\fR. .AP "Tcl_Obj *const" objv[] in The elements to join to the given base path. +.AP Tcl_Obj *linkNamePtr in +The name of the link to be created or read. +.AP Tcl_Obj *toPtr in +What the link called \fIlinkNamePtr\fR should be linked to, or NULL if +the symbolic link specified by \fIlinkNamePtr\fR is to be read. +.AP int linkAction in +OR-ed combination of flags indicating what kind of link should be +created (will be ignored if \fItoPtr\fR is NULL). Valid bits to set +are \fBTCL_CREATE_SYMBOLIC_LINK\fR and \fBTCL_CREATE_HARD_LINK\fR. +When both flags are set and the underlying filesystem can do either, +symbolic links are preferred. .BE .SH DESCRIPTION |