File: 200-notes.html

package info (click to toggle)
libexplain 1.4.D001-16
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,228 kB
  • sloc: ansic: 156,043; makefile: 47,892; sh: 16,304; yacc: 1,898; awk: 245
file content (121 lines) | stat: -rw-r--r-- 3,495 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!--
  libexplain - Explain errno values returned by libc functions
  Copyright (C) 2009, 2010 Peter Miller
  Written by Peter Miller <pmiller@opensource.org.au>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or (at
  your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
.hy 0
.ad l
<!DOCTYPE HTML PUBLIC
    "-//W3C//DTD HTML 4.01 Transitional//EN"
    "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"
    >
.nf
<html>
<head>
<title>
No Medium Found, 2.0, Notes
</title>
</head>
<body>

<table width="100%" >
<tr>
    <td align="left" >
        <a href="100-notes.html" >Prev</a>,
        <a href="000-notes.html" >Top</a>
    </td><td align="right" >
        <a href="200-slide.html" >Slide</a>,
        <a href="300-notes.html" >Next</a>
    </td>
</tr>
</table>

<h1 >
2. Using the Library
</h1>

<h2> 2.1 The simple case </h2>

const char *explain_rename(const char *oldpath, const char *newpath);
<br/>
<a href="210-slide.html" >slide</a>

<h2> 2.2 The errno case </h2>

const char *explain_errno_rename(int errno, const char *oldpath,
const char *newpath);
<br/>
<a href="220-slide.html" >slide</a>

<h2> 2.3 Multi-thread </h2>

const char *explain_message_rename(char *msg, size_t msg_size, int errno,
const char *oldpath, const char *newpath);
<br/>
const char *explain_message_errno_rename(char *msg, size_t msg_size, int errno,
const char *oldpath, const char *newpath);
<br/>
<a href="230-slide.html" >slide</a>

<h2> 2.4 Interface Sugar </h2>

int explain_rename_or_die(const char *oldpath, const char *newpath);
<br>
int explain_rename_on_error(const char *oldpath, const char *newpath);
<br/>
<a href="240-slide.html" >slide</a>

<h2> 2.5 All the other system calls </h2>

as above, but as appropriate
<br/>
<a href="250-slide.html" >slide</a>

<h2> 2.6 cat </h2>

<a href="260-slide.html" >slide</a>
<ul>
<li> code example
<li> full error handling, no tramp data
<li> even works for stdout
</ul>

<h2> 2.7 Rusty's Scale of Interface Goodness </h2>
<a href="270-slide.html" >slide</a>

<table >
<tr><td valign="top" align="right" >10.</td>
<td valign="top" >It's impossible to get wrong.</td></tr>
<tr><td valign="top" align="right" >9.</td>
<td valign="top" >The compiler or linker won't let you get it
wrong.</td></tr>
<tr><td valign="top" align="right" >8.</td>
<td valign="top" >The compiler will warn if you get it wrong.</td></tr>
<tr><td valign="top" align="right" >7.</td>
<td valign="top" >The obvious use is (probably) the correct one.</td></tr>
<tr><td valign="top" align="right" >6.</td>
<td valign="top" >The name tells you how to use it.</td></tr>
<tr><td valign="top" align="right" >5.</td>
<td valign="top" >Do it right or it will break at runtime.</td></tr>
<tr><td valign="top" align="right" >4.</td>
<td valign="top" >Follow common convention and you'll get it
right.</td></tr>
<tr><td valign="top" align="right" >3.</td>
<td valign="top" >Read the documentation and you'll get it right.</td></tr>
</table>

</body>
</html>