<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[147608] trunk/doc-new/guide/xml/portfile-tcl.xml</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="https://trac.macports.org/changeset/147608">147608</a></dd>
<dt>Author</dt> <dd>cal@macports.org</dd>
<dt>Date</dt> <dd>2016-04-09 12:29:21 -0700 (Sat, 09 Apr 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>guide: 'file' is not a Tcl extension, #51104
Clear up the confusion that 'file' is a MacPorts-provided Tcl extension (which
it isn't) and add some descriptions to the file functions.
Closes: #51104</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocnewguidexmlportfiletclxml">trunk/doc-new/guide/xml/portfile-tcl.xml</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocnewguidexmlportfiletclxml"></a>
<div class="modfile"><h4>Modified: trunk/doc-new/guide/xml/portfile-tcl.xml (147607 => 147608)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/doc-new/guide/xml/portfile-tcl.xml 2016-04-09 19:19:24 UTC (rev 147607)
+++ trunk/doc-new/guide/xml/portfile-tcl.xml 2016-04-09 19:29:21 UTC (rev 147608)
</span><span class="lines">@@ -2,29 +2,36 @@
</span><span class="cx"> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
</span><span class="cx"> "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
</span><span class="cx"> <section id="reference.tcl-extensions">
</span><del>- <title>Tcl Extensions</title>
</del><ins>+ <title>Tcl Extensions &amp; Useful Tcl Commands</title>
</ins><span class="cx">
</span><span class="cx"> <para>A MacPorts Portfile is a Tcl script, so it may contain any arbitrary
</span><span class="cx"> Tcl code you may learn about in a <ulink
</span><span class="cx"> url="http://tmml.sourceforge.net/doc/tcl/">Tcl reference manual</ulink>.
</span><span class="cx"> However, few authors will use arbitrary Tcl code; the vast majority will use
</span><del>- Tcl extensions that are coded within MacPorts for performing the most common
- tasks needed for Portfiles. The list below is a list of Tcl extensions
- provided by MacPorts base.</para>
</del><ins>+ a subset of Tcl commands and a number of Tcl extensions that are coded within
+ MacPorts for performing the most common tasks needed for Portfiles. The list
+ below is a list of useful Tcl commands for Portfile development and Tcl
+ extensions provided by MacPorts base.</para>
</ins><span class="cx">
</span><span class="cx"> <variablelist>
</span><span class="cx"> <varlistentry>
</span><span class="cx"> <term>file</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para>Description.</para>
</del><ins>+ <para>The standard Tcl <command>file</command> command can be used for
+ a number of operations on files, such as moving, renaming, deleting,
+ or creating directories, among others. For a complete list, consult
+ the <ulink url="http://tmml.sourceforge.net/doc/tcl/file.html">Tcl
+ reference manual for the <command>file</command> command</ulink>,
+ or the Tcl file manpage in the <option>n</option> section of manpages
+ on your machine using <command>man n file</command></para>
</ins><span class="cx">
</span><span class="cx"> <variablelist>
</span><span class="cx"> <varlistentry>
</span><span class="cx"> <term>file copy</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para></para>
</del><ins>+ <para>Copy a file.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx"> </varlistentry>
</span><span class="cx"> </variablelist>
</span><span class="lines">@@ -34,7 +41,7 @@
</span><span class="cx"> <term>file rename</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para></para>
</del><ins>+ <para>Rename a file.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx"> </varlistentry>
</span><span class="cx"> </variablelist>
</span><span class="lines">@@ -44,7 +51,8 @@
</span><span class="cx"> <term>file delete [-force]</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para></para>
</del><ins>+ <para>Remove a file or (with <option>-force</option>) a directory
+ and its contents.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx"> </varlistentry>
</span><span class="cx"> </variablelist>
</span><span class="lines">@@ -54,7 +62,7 @@
</span><span class="cx"> <term>file mkdir</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para></para>
</del><ins>+ <para>Create a directory.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx"> </varlistentry>
</span><span class="cx"> </variablelist>
</span><span class="lines">@@ -65,7 +73,11 @@
</span><span class="cx"> <term>macros</term>
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><del>- <para>Description.</para>
</del><ins>+ <para>For the above operations provided by Tcl's
+ <command>file</command> command, MacPorts provides the following
+ shorthands. These used to be separate functions to work around bugs
+ in older Tcl versions or on old versions of OS X. Nowadays those are
+ simple aliases.</para>
</ins><span class="cx">
</span><span class="cx"> <variablelist>
</span><span class="cx"> <varlistentry>
</span><span class="lines">@@ -91,8 +103,9 @@
</span><span class="cx">
</span><span class="cx"> <listitem>
</span><span class="cx"> <para>Deletes each of the given files/directories. Behaves
</span><del>- similarly to file delete -force except that file delete -force
- will fail to delete directories properly on 10.3 systems.</para>
</del><ins>+ similarly to file delete -force except that file delete -force
+ will fail to delete directories properly on 10.3
+ systems.</para>
</ins><span class="cx"> </listitem>
</span><span class="cx"> </varlistentry>
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>