Check-in [1aae3d3b57]
Not logged in
Home Help Timeline Files Branches Tags Forum Tickets Wiki More... Login
Overview
Comment:Minor enhancement to documentation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 1aae3d3b57dc4d0ed33bac4775eb4ce28f9f74e3
User & Date: mistachkin on 2019-08-19 05:03:31
Other Links: manifest | tags
Context
2019-08-19
20:27
Order the documentation: public, internal, private. check-in: bcf1a6a4e4 user: mistachkin tags: trunk
05:03
Minor enhancement to documentation. check-in: 1aae3d3b57 user: mistachkin tags: trunk
01:05
Fix formatting of the documentation. check-in: 33003b2f13 user: mistachkin tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Modified doc/v1.html from [dfa87955a9] to [3a46b43a60]. 

1
2
3
4
5
6
7
8

<div class="fossil-doc" data-title="Package Client v1 Documentation"><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;setupCommonVariables&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>

|








1
2
3
4
5
6
7
8

<div class="fossil-doc" data-title="Package Client Toolset API v1"><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;setupCommonVariables&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;force&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
︙︙
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81


<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;redirectLimit&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;quiet&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;getEagle.tcl&quot; script.  It is<br>
designed to process a single HTTP request, including any HTTP<br>
3XX redirects (up to the specified limit), and return the raw<br>
HTTP response data.  It may raise any number of script errors.<br>
</blockquote><br><hr><br>








|








67
68
69
70
71
72
73
74
75
76
77
78
79
80
81


<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;redirectLimit&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;channel&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;quiet&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure was stolen from the &quot;getEagle.tcl&quot; script.  It is<br>
designed to process a single HTTP request, including any HTTP<br>
3XX redirects (up to the specified limit), and return the raw<br>
HTTP response data.  It may raise any number of script errors.<br>
</blockquote><br><hr><br>
︙︙
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529

checkout.  There are no arguments.  An empty string is returned if<br>
the information cannot be determined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;joinPath&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure builds a native path using the specified parts and<br>
returns it.  All arguments are considered to be parts of the path.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;verifyCheckoutDirectory&quot;</span></big></big><br>








|








1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529

checkout.  There are no arguments.  An empty string is returned if<br>
the information cannot be determined.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;joinPath&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure builds a native path using the specified parts and<br>
returns it.  All arguments are considered to be parts of the path.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;verifyCheckoutDirectory&quot;</span></big></big><br>
︙︙
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723

</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;listBoxEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles double-clicking the<br>
list box in both Tk and Eagle.  The varName argument is the name of<br>
the scalar variable that must be updated with the list of items from<br>
the list box -OR- the list of items from an interactive file picker<br>
dialog.  The args argument, which is only used for Eagle, is a list<br>
containing two elements.  The first element is the control involved<br>
in the event.  The second element is any extra data that may be<br>
necessary to process the event.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;handleFormClosedEvent&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the Closed event for<br>
a WinForms form -OR- the WM_DELETE_WINDOW event on a Tk window.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;submitEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the submit button in<br>
both Tk and Eagle.  It starts the package submission process.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;clearEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the clear button in<br>
Tk and Eagle.  It is used to clear the package submission data.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>








|















|












|












|








1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723

</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;listBoxEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Required argument &quot;varName&quot;</span></big><br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles double-clicking the<br>
list box in both Tk and Eagle.  The varName argument is the name of<br>
the scalar variable that must be updated with the list of items from<br>
the list box -OR- the list of items from an interactive file picker<br>
dialog.  The args argument, which is only used for Eagle, is a list<br>
containing two elements.  The first element is the control involved<br>
in the event.  The second element is any extra data that may be<br>
necessary to process the event.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;handleFormClosedEvent&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the Closed event for<br>
a WinForms form -OR- the WM_DELETE_WINDOW event on a Tk window.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Internal API Procedure &quot;submitEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the submit button in<br>
both Tk and Eagle.  It starts the package submission process.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>
</blockquote><br><hr><br>

<big><big><span style="font-family: monospace;">Private Procedure &quot;clearEventHandler&quot;</span></big></big><br>
<br>

<big><span style="font-family: monospace;">&nbsp;&nbsp;&nbsp;&nbsp;Optional argument list &quot;args&quot;</span></big><br>

<blockquote style="font-family: monospace;"><br>
This procedure is an event handler.  It handles the clear button in<br>
Tk and Eagle.  It is used to clear the package submission data.  The<br>
args argument is not really used, it is a placeholder to make this<br>
procedure more portable between Tcl and Eagle.  This procedure may<br>
raise script errors.<br>
︙︙

This page was generated in about 0.011s by Fossil version 2.20 Tcl version 8.6.12 [658547aa7c] 2022-10-09 01:11:55