summaryrefslogtreecommitdiffstats
path: root/linux-api-ml.html
blob: de45b11a790027d546452e0253491354cbeaeaa7 (plain)
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
        "https://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8" />
<link rel=stylesheet type="text/css" href="style.css" title="style">
<title>
The linux-api mailing list
</title>
</head>

<body>

<!--BEGIN-LINKS-->
<form method="get" action="https://www.google.com/search">
<table border=0 cellpadding=0 cellspacing=0 width="100%">
<tr>
<td align="left">
<font size="-1">

Linux <em>man-pages</em>: &nbsp;
<a href="./index.html">home</a>
&nbsp; || &nbsp;
<a href="https://git.kernel.org/pub/scm/docs/man-pages/">git</a>
| <a href="https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/README">readme</a>
| <a href="https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING">contributing</a>
| <a href="https://www.alejandro-colomar.es/share/dist/man-pages/git/HEAD/man-pages-HEAD.pdf#man-pages.7">conventions</a>
&nbsp; | &nbsp;
<a href="https://subspace.kernel.org/vger.kernel.org.html">mailing list</a>
| <a href="https://lore.kernel.org/linux-man/">archives</a>
&nbsp; | &nbsp;
<a href="https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/">releases</a>
| <a href="https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/book/">book</a>
| <a href="https://man7.org/linux/man-pages/index.html">online pages</a>
</td>
<td align="right">
<input type="text" name="q" size=10 maxlength=255 value="">
<input type="hidden" name="sitesearch" value="man7.org/linux/man-pages">
<input type="submit" name="sa" value="Search online pages">
</td>
</tr>
</table>
</form>
<!--END-LINKS-->


<h1>The linux-api mailing list</h1>

    <p>
        Following a session
	(<a href="https://man7.org/conf/lpc2008/who_owns_the_interface.pdf">Who own's the interface</a>)
	led by Michael Kerrisk at the 2008 Linux Plumbers Conference,
	the <em>linux-api</em> mailing list
        (<span class="email">linux-api@vger.kernel.org</span>)
	was created as a forum to discuss
        changes that affect the Linux programming interface</a>
        (API or ABI).
    </p>

    <p>
        Among other things, a primary goal of the list is to help
	answer the question: <em>How do we even know when an interface has been
	added or changed?</em>
	Many people have an interest in the answer to that question,
	including:
	<ul>
	    <li>
	        maintainers of C libraries,
	    </li>
	    <li>
	        the <em>man-pages</em> project,
	    </li>
	    <li>
		testing projects such as
		<a href="https://linux-test-project.github.io/">LTP</a>
		and
		<a href="http://codemonkey.org.uk/projects/trinity/">trinity</a>,
	    </li>
	    <li>
		maintainers of tracing tools such as
		<a href="https://sourceforge.net/projects/strace/">strace(1)</a>,
	    </li>
	    <li>
	        the <a href="https://www.linuxfoundation.org/collaborate/workgroups/lsb">Linux Standard Base (LSB)</a>,
	    </li>
	    <li>
	        (possibly) other groups, such as the maintainers for the
		<a href="https://kernelnewbies.org/LinuxChanges">LinuxChanges</a>
		page at kernelnewbies.org,
	    </li>
	    <li>
		and, of course, user-space programmers.
	    </li>
	</ul>

    <p>
	The difficulty of answering that question is a contributing factor
	to many problems in the Linux API&mdash;for example,
	insufficient design review before release
	(with the consequence that mistakes in API designs
	are recognized too late),
	insufficient prerelease testing,
	poor or late documentation,
	and delays before kernel APIs are made
	available via C libraries.
    </p>

    <p>
        The kernel source file
	<span class="pathname">Documentation/SubmitChecklist</span>
	notes that all Linux kernel
	<strong>patches that change userspace interfaces should be CCed to
	linux-api@vger.kernel.org</strong>.
	You would help many people by heeding that advice,
	and in return your kernel patches might even see a bit more view
	and get better documentation, faster.
    </p>
    <p>
       Message for easy pasting into mail threads ;-):
    </p>
    <blockquote>
    <p>
      [CC += linux-api@vger.kernel.org]
    </p>
    <p>
       	Since this is a kernel-user-space API change,
	could you please CC linux-api@ (and also for any
	future iterations of this patch series).  The kernel source
	file Documentation/SubmitChecklist notes that all Linux kernel patches
	that change userspace interfaces should be CCed to
	linux-api@vger.kernel.org, so that the various
	parties who are interested in API changes are informed. For further information, see
	https://www.kernel.org/doc/man-pages/linux-api-ml.html
   </p>
    </blockquote>

<h2>Subscription and archive</h2>

    <p>
        To subscribe to the list, send a message containing the
        following <em>body</em> to
        <span class="email">majordomo@vger.kernel.org</span>:
    </p>

    <pre>    subscribe linux-api </pre>

    <p>
        Searchable archives of this list can be found on
        <a href="https://lore.kernel.org/linux-api/">lore</a>.
	and
	<a href="https://marc.info/?l=linux-api">MARC</a>.
    </p>

<!--BEGIN-STATCOUNTER-->
<!-- SITETRACKING.linux_man-pages -->
<!-- Start of StatCounter Code -->
<script type="text/javascript">
var sc_project=5618989;
var sc_invisible=1;
var sc_partition=60;
var sc_click_stat=1;
var sc_security="4f8507d7";
</script>

<script type="text/javascript"
src="https://www.statcounter.com/counter/counter.js"></script><noscript><div
class="statcounter"><a title="customisable counter"
href="https://www.statcounter.com/free_hit_counter.html"
target="_blank"><img class="statcounter"
src="https://c.statcounter.com/5618989/0/4f8507d7/1/" alt="customisable
counter" ></a></div></noscript>
<!-- End of StatCounter Code -->
<!--END-STATCOUNTER-->
</body>
</html>