Mercurial > hg > octave-nkf > gnulib-hg
annotate doc/gnulib.texi @ 8475:1d8215560713
Fix typos.
Suggested by Thien-Thi Nguyen <ttn@gnuvola.org>.
| author | Ben Pfaff <blp@gnu.org> |
|---|---|
| date | Mon, 19 Mar 2007 20:30:25 +0000 |
| parents | 51634bc628de |
| children | c1709670004e |
| rev | line source |
|---|---|
| 5239 | 1 \input texinfo @c -*-texinfo-*- |
| 8475 | 2 @comment $Id: gnulib.texi,v 1.34 2007-03-19 20:30:25 blp Exp $ |
| 5239 | 3 @comment %**start of header |
| 4 @setfilename gnulib.info | |
| 5 @settitle GNU Gnulib | |
|
5256
e23bd8e9d368
import sections from Simon
Karl Berry <karl@freefriends.org>
parents:
5239
diff
changeset
|
6 @syncodeindex fn cp |
| 5239 | 7 @syncodeindex pg cp |
| 8 @comment %**end of header | |
| 9 | |
| 8475 | 10 @set UPDATED $Date: 2007-03-19 20:30:25 $ |
| 5239 | 11 |
| 12 @copying | |
| 13 This manual is for GNU Gnulib (updated @value{UPDATED}), | |
| 14 which is a library of common routines intended to be shared at the | |
| 15 source level. | |
| 16 | |
|
7778
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
17 Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
| 5239 | 18 |
| 19 Permission is granted to copy, distribute and/or modify this document | |
| 20 under the terms of the GNU Free Documentation License, Version 1.1 or | |
| 21 any later version published by the Free Software Foundation; with no | |
|
7778
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
22 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
|
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
23 Texts. A copy of the license is included in the section entitled |
|
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
24 ``GNU Free Documentation License.'' |
| 5239 | 25 @end copying |
| 26 | |
| 27 @dircategory Software development | |
| 28 @direntry | |
| 5257 | 29 * Gnulib: (gnulib). Source files to share among distributions. |
| 5239 | 30 @end direntry |
| 31 | |
| 32 @titlepage | |
| 33 @title GNU Gnulib | |
| 34 @subtitle updated @value{UPDATED} | |
| 35 @author @email{bug-gnulib@@gnu.org} | |
| 36 @page | |
| 37 @vskip 0pt plus 1filll | |
| 38 @insertcopying | |
| 39 @end titlepage | |
| 40 | |
| 41 @contents | |
| 42 | |
| 43 @ifnottex | |
| 44 @node Top | |
| 45 @top GNU Gnulib | |
| 46 | |
| 47 @insertcopying | |
| 48 @end ifnottex | |
| 49 | |
| 50 @menu | |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
51 * Introduction:: |
| 5239 | 52 * Invoking gnulib-tool:: |
|
7618
549e482b5ecd
* README: Fix typo.
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
7548
diff
changeset
|
53 * Miscellaneous Notes:: |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
54 * Particular Modules:: Documentation of Individual Modules |
| 5239 | 55 * Copying This Manual:: |
| 56 * Index:: | |
| 57 @end menu | |
| 58 | |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
59 @node Introduction |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
60 @chapter Introduction |
| 5239 | 61 |
| 7548 | 62 Gnulib is a source code library. It provides basic functionalities to |
| 63 programs and libraries. Currently (as of October 2006) more than 30 | |
| 64 packages make use of Gnulib. | |
| 65 | |
| 66 Resources: | |
| 5239 | 67 |
| 68 @itemize | |
| 69 @item Gnulib is hosted at Savannah: | |
| 70 @url{http://savannah.gnu.org/projects/gnulib}. Get the sources | |
| 71 through CVS from there. | |
| 72 @item The Gnulib home page: | |
| 73 @url{http://www.gnu.org/software/gnulib/}. | |
| 74 @end itemize | |
| 75 | |
| 7548 | 76 @menu |
| 77 * Library vs. Reusable Code:: | |
| 78 * Portability and Application Code:: | |
| 79 * Modules:: | |
| 80 * Various Kinds of Modules:: | |
| 81 * Collaborative Development:: | |
| 82 * Copyright:: | |
| 83 * Steady Development:: | |
| 84 * Openness:: | |
| 85 @end menu | |
| 86 | |
| 87 @include gnulib-intro.texi | |
| 88 | |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
89 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
90 @include gnulib-tool.texi |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
91 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
92 |
|
7618
549e482b5ecd
* README: Fix typo.
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
7548
diff
changeset
|
93 @node Miscellaneous Notes |
|
549e482b5ecd
* README: Fix typo.
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
7548
diff
changeset
|
94 @chapter Miscellaneous Notes |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
95 |
| 5239 | 96 @menu |
| 97 * Comments:: | |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
98 * Header files:: |
| 5239 | 99 * Out of memory handling:: |
|
5938
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
100 * Library version handling:: |
|
6852
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
101 * Windows sockets:: |
|
6962
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
102 * Libtool and Windows:: |
|
7334
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
103 * License Texinfo sources:: |
|
8433
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
104 * Build robot for gnulib:: |
| 5239 | 105 @end menu |
| 106 | |
|
5982
8f55c4ac38d6
updates from Patrice, start at quoting
Karl Berry <karl@freefriends.org>
parents:
5938
diff
changeset
|
107 |
| 5239 | 108 @node Comments |
| 109 @section Comments | |
| 110 | |
| 111 @cindex comments describing functions | |
| 112 @cindex describing functions, locating | |
| 113 Where to put comments describing functions: Because of risk of | |
| 114 divergence, we prefer to keep most function describing comments in | |
| 115 only one place: just above the actual function definition. Some | |
| 116 people prefer to put that documentation in the .h file. In any case, | |
| 117 it should appear in just one place unless you can ensure that the | |
| 118 multiple copies will always remain identical. | |
| 119 | |
| 120 | |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
121 @node Header files |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
122 @section Header files |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
123 |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
124 @cindex double inclusion of header files |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
125 @cindex header file include protection |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
126 It is a tradition to use CPP tricks to avoid parsing the same header |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
127 file more than once, which might cause warnings. The trick is to wrap |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
128 the content of the header file (say, @file{foo.h}) in a block, as in: |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
129 |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
130 @example |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
131 #ifndef FOO_H |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
132 # define FOO_H |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
133 ... |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
134 body of header file goes here |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
135 ... |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
136 #endif /* FOO_H */ |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
137 @end example |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
138 |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
139 Whether to use @code{FOO_H} or @code{_FOO_H} is a matter of taste and |
|
5261
95f7304acdac
Minor fixups to previous patch.
Paul Eggert <eggert@cs.ucla.edu>
parents:
5260
diff
changeset
|
140 style. The C89 and C99 standards reserve all identifiers that begin with an |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
141 underscore and either an uppercase letter or another underscore, for |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
142 any use. Thus, in theory, an application might not safely assume that |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
143 @code{_FOO_H} has not already been defined by a library. On the other |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
144 hand, using @code{FOO_H} will likely lead the higher risk of |
| 5269 | 145 collisions with other symbols (e.g., @code{KEY_H}, @code{XK_H}, @code{BPF_H}, |
| 146 which are CPP macro constants, or @code{COFF_LONG_H}, which is a CPP | |
| 147 macro function). Your preference may depend on whether you consider | |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
148 the header file under discussion as part of the application (which has |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
149 its own namespace for CPP symbols) or a supporting library (that |
|
5261
95f7304acdac
Minor fixups to previous patch.
Paul Eggert <eggert@cs.ucla.edu>
parents:
5260
diff
changeset
|
150 shouldn't interfere with the application's CPP symbol namespace). |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
151 |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
152 @cindex C++ header files |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
153 @cindex Header files and C++ |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
154 Adapting C header files for use in C++ applications can use another |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
155 CPP trick, as in: |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
156 |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
157 @example |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
158 # ifdef __cplusplus |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
159 extern "C" |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
160 @{ |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
161 # endif |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
162 ... |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
163 body of header file goes here |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
164 ... |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
165 # ifdef __cplusplus |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
166 @} |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
167 # endif |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
168 @end example |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
169 |
|
5261
95f7304acdac
Minor fixups to previous patch.
Paul Eggert <eggert@cs.ucla.edu>
parents:
5260
diff
changeset
|
170 The idea here is that @code{__cplusplus} is defined only by C++ |
|
95f7304acdac
Minor fixups to previous patch.
Paul Eggert <eggert@cs.ucla.edu>
parents:
5260
diff
changeset
|
171 implementations, which will wrap the header file in an @samp{extern "C"} |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
172 block. Again, whether to use this trick is a matter of taste and |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
173 style. While the above can be seen as harmless, it could be argued |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
174 that the header file is written in C, and any C++ application using it |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
175 should explicitly use the @samp{extern "C"} block itself. Your |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
176 preference might depend on whether you consider the API exported by |
|
5261
95f7304acdac
Minor fixups to previous patch.
Paul Eggert <eggert@cs.ucla.edu>
parents:
5260
diff
changeset
|
177 your header file as something available for C programs only, or for C |
|
5260
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
178 and C++ programs alike. |
|
5a0174704b16
header files, from simon
Karl Berry <karl@freefriends.org>
parents:
5257
diff
changeset
|
179 |
|
5982
8f55c4ac38d6
updates from Patrice, start at quoting
Karl Berry <karl@freefriends.org>
parents:
5938
diff
changeset
|
180 @subheading Include ordering |
|
5883
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
181 |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
182 When writing a gnulib module, or even in general, a good way to order |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
183 the @samp{#include} directives is the following. |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
184 |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
185 @itemize |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
186 @item First comes the #include "..." specifying the module being implemented. |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
187 @item Then come all the #include <...> of system or system-replacement headers, |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
188 in arbitrary order. |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
189 @item Then come all the #include "..." of gnulib and private headers, in |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
190 arbitrary order. |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
191 @end itemize |
|
19bb5e876a29
Add "Include ordering", based on e-mail from Bruno.
Simon Josefsson <simon@josefsson.org>
parents:
5870
diff
changeset
|
192 |
|
5982
8f55c4ac38d6
updates from Patrice, start at quoting
Karl Berry <karl@freefriends.org>
parents:
5938
diff
changeset
|
193 |
| 5239 | 194 @node Out of memory handling |
| 195 @section Out of memory handling | |
| 196 | |
| 197 @cindex Out of Memory handling | |
| 198 @cindex Memory allocation failure | |
| 199 The GSS API does not have a standard error code for the out of memory | |
| 200 error condition. Instead of adding a non-standard error code, this | |
| 201 library has chosen to adopt a different strategy. Out of memory | |
| 202 handling happens in rare situations, but performing the out of memory | |
| 203 error handling after almost all API function invocations pollute your | |
| 204 source code and might make it harder to spot more serious problems. | |
| 8475 | 205 The strategy chosen improves code readability and robustness. |
| 5239 | 206 |
| 207 @cindex Aborting execution | |
| 208 For most applications, aborting the application with an error message | |
| 8475 | 209 when the out of memory situation occurs is the best that can be wished |
| 5239 | 210 for. This is how the library behaves by default. |
| 211 | |
| 212 @vindex xalloc_fail_func | |
| 213 However, we realize that some applications may not want to have the | |
| 8475 | 214 GSS library abort execution in any situation. The GSS library supports |
| 5239 | 215 a hook to let the application regain control and perform its own |
|
6945
aa195d9ecb02
* functions.texi, gnulib-tool.texi, gnulib.texi: Fix some typos.
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
6852
diff
changeset
|
216 cleanups when an out of memory situation has occurred. The application |
| 5239 | 217 can define a function (having a @code{void} prototype, i.e., no return |
| 218 value and no parameters) and set the library variable | |
| 219 @code{xalloc_fail_func} to that function. The variable should be | |
| 220 declared as follows. | |
| 221 | |
| 222 @example | |
| 223 extern void (*xalloc_fail_func) (void); | |
| 224 @end example | |
| 225 | |
| 226 The GSS library will invoke this function if an out of memory error | |
| 227 occurs. Note that after this the GSS library is in an undefined | |
| 228 state, so you must unload or restart the application to continue call | |
| 229 GSS library functions. The hook is only intended to allow the | |
| 230 application to log the situation in a special way. Of course, care | |
| 231 must be taken to not allocate more memory, as that will likely also | |
| 232 fail. | |
| 233 | |
| 234 | |
|
5938
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
235 @node Library version handling |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
236 @section Library version handling |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
237 |
|
5992
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
238 The module @samp{check-version} can be useful when your gnulib |
|
5938
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
239 application is a system library. You will typically wrap the call to |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
240 the @code{check_version} function through a library API, your library |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
241 header file may contain: |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
242 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
243 @example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
244 #define STRINGPREP_VERSION "0.5.18" |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
245 ... |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
246 extern const char *stringprep_check_version (const char *req_version); |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
247 @end example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
248 |
|
5992
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
249 To avoid ELF symbol collisions with other libraries that use the |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
250 @samp{check-version} module, add to @file{config.h} through a |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
251 AC_DEFINE something like: |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
252 |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
253 @example |
|
6842
1b6de7675435
mention that Gnulib takes over LIBOBJS
Karl Berry <karl@freefriends.org>
parents:
6764
diff
changeset
|
254 AC_DEFINE(check_version, stringprep_check_version, |
|
1b6de7675435
mention that Gnulib takes over LIBOBJS
Karl Berry <karl@freefriends.org>
parents:
6764
diff
changeset
|
255 [Rename check_version.]) |
|
5992
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
256 @end example |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
257 |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
258 The @code{stringprep_check_version} function will thus be implemented |
|
6cf595732ddb
gnulib.texi (Library version handling): Add ELF symbol collision
Simon Josefsson <simon@josefsson.org>
parents:
5983
diff
changeset
|
259 by the @code{check_version} module. |
|
5938
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
260 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
261 There are two uses of the interface. The first is a way to provide |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
262 for applications to find out the version number of the library it |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
263 uses. The application may contain diagnostic code such as: |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
264 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
265 @example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
266 printf ("Stringprep version: header %s library %s", |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
267 STRINGPREP_VERSION, |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
268 stringprep_check_version (NULL)); |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
269 @end example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
270 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
271 Separating the library and header file version can be useful when |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
272 searching for version mismatch related problems. |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
273 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
274 The second uses is as a rudimentary test of proper library version, by |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
275 making sure the application get a library version that is the same, or |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
276 newer, than the header file used when building the application. This |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
277 doesn't catch all problems, libraries may change backwards incompatibly |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
278 in later versions, but enable applications to require a certain |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
279 minimum version before it may proceed. |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
280 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
281 Typical uses look like: |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
282 |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
283 @example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
284 /* Check version of libgcrypt. */ |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
285 if (!gcry_check_version (GCRYPT_VERSION)) |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
286 die ("version mismatch\n"); |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
287 @end example |
|
14697da96543
2005-06-28 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
5883
diff
changeset
|
288 |
|
5982
8f55c4ac38d6
updates from Patrice, start at quoting
Karl Berry <karl@freefriends.org>
parents:
5938
diff
changeset
|
289 |
|
6852
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
290 @node Windows sockets |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
291 @section Windows sockets |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
292 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
293 There are several issues when building applications that should work |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
294 under Windows. The most problematic part is for applications that use |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
295 sockets. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
296 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
297 Hopefully, we can add helpful notes to this section that will help you |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
298 port your application to Windows using gnulib. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
299 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
300 @subsection Getaddrinfo and WINVER |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
301 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
302 This was written for the getaddrinfo module, but may be applicable to |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
303 other functions too. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
304 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
305 The getaddrinfo function exists in ws2tcpip.h and -lws2_32 on Windows |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
306 XP. The function declaration is present if @code{WINVER >= 0x0501}. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
307 Windows 2000 does not have getaddrinfo in its @file{WS2_32.dll}. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
308 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
309 Thus, if you want to assume Windows XP or later, you can add |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
310 AC_DEFINE(WINVER, 0x0501) to avoid compiling to (partial) getaddrinfo |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
311 implementation. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
312 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
313 If you want to support Windows 2000, don't do anything, but be aware |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
314 that gnulib will use its own (partial) getaddrinfo implementation even |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
315 on Windows XP. Currently the code does not attempt to determine if |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
316 the getaddrinfo function is available during runtime. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
317 |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
318 Todo: Make getaddrinfo.c open the WS2_32.DLL and check for the |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
319 getaddrinfo symbol and use it if present, otherwise fall back to our |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
320 own implementation. |
|
9582dd5af1a5
Fix getaddrinfo on Windows 2000.
Simon Josefsson <simon@josefsson.org>
parents:
6842
diff
changeset
|
321 |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
322 |
|
6962
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
323 @node Libtool and Windows |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
324 @section Libtool and Windows |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
325 |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
326 If you want it to be possible to cross-compile your program to MinGW |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
327 and you use Libtool, you need to put: |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
328 |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
329 @example |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
330 AC_LIBTOOL_WIN32_DLL |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
331 @end example |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
332 |
|
6989
d4c72f8cb784
* gnulib.texi (Libtool and Windows): Eliminate passive voice. Correct
Derek R. Price <derek@ximbiot.com>
parents:
6962
diff
changeset
|
333 in your @file{configure.ac}. This sets the correct names for the |
|
d4c72f8cb784
* gnulib.texi (Libtool and Windows): Eliminate passive voice. Correct
Derek R. Price <derek@ximbiot.com>
parents:
6962
diff
changeset
|
334 @code{OBJDUMP}, @code{DLLTOOL}, and @code{AS} tools for the build. |
|
6962
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
335 |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
336 If you are building a library, you will also need to pass |
|
6989
d4c72f8cb784
* gnulib.texi (Libtool and Windows): Eliminate passive voice. Correct
Derek R. Price <derek@ximbiot.com>
parents:
6962
diff
changeset
|
337 @code{-no-undefined} to make sure Libtool produces a DLL for your |
|
6962
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
338 library. From a @file{Makefile.am}: |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
339 |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
340 @example |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
341 libgsasl_la_LDFLAGS += -no-undefined |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
342 @end example |
|
e33f191db3d6
2006-07-14 Simon Josefsson <jas@extundo.com>
Simon Josefsson <simon@josefsson.org>
parents:
6945
diff
changeset
|
343 |
|
7334
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
344 |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
345 @node License Texinfo sources |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
346 @section License Texinfo sources |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
347 |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
348 Gnulib provides copies of the GNU GPL, GNU LGPL, and GNU FDL licenses |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
349 in Texinfo form. (The master location is |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
350 @url{http://www.gnu.org/licenses/}). These Texinfo documents have |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
351 various node names and structures built into them; for your manual, |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
352 you might like to change these. It's ok to do this, and a convenient |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
353 way to do so is to use a context diff and the @option{--local-dir} |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
354 option to @command{gnulib-tool}. |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
355 |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
356 Of course the license texts themselves should not be changed at all. |
|
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
357 |
|
8433
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
358 @node Build robot for gnulib |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
359 @section Build robot for gnulib |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
360 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
361 To simplify testing on a wide set of platforms, gnulib is built on |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
362 many platforms every day and the results are uploaded to: |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
363 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
364 @url{http://autobuild.josefsson.org/gnulib/} |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
365 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
366 If you wish to help the gnulib development effort with build logs for |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
367 your favorite platform, you may perform these steps: |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
368 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
369 @enumerate |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
370 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
371 @item Create gnulib directory |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
372 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
373 On a machine with recent automake, autoconf, m4 installed and with a |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
374 gnulib cvs checkout (typically a Linux machine), use |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
375 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
376 @example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
377 gnulib-tool --create-megatestdir --with-tests --dir=..." |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
378 @end example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
379 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
380 Note: The created directory uses ca. 512 MB on disk. |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
381 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
382 @item Transfer gnulib directory |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
383 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
384 Transfer this directory to a build machine (HP-UX, Cygwin, or |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
385 whatever). Often it is easier to transfer one file, and this can be |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
386 achieved by running, inside the directory the following commands: |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
387 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
388 @example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
389 ./configure |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
390 make dist |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
391 @end example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
392 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
393 And then transferring the @file{dummy-0.tar.gz} file. |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
394 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
395 @item Build modules |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
396 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
397 On the build machine, run ./autobuild (or "nohup ./autobuild"). It |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
398 creates a directory 'logs/' with a log file for each module. |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
399 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
400 @item Submit build logs |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
401 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
402 Submit each log file to Simon's site, either through a |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
403 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
404 @example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
405 mail `echo gnulib__at__autobuild.josefsson.org | sed -e s/__at__/@/` |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
406 @end example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
407 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
408 or through netcat |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
409 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
410 @example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
411 autobuild-submit logs/* |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
412 @end example |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
413 |
|
51634bc628de
* lib/quotearg.c: Include <wctype.h> early, before the definition of
Paul Eggert <eggert@cs.ucla.edu>
parents:
8272
diff
changeset
|
414 @end enumerate |
|
7334
c7c3e5be0d91
note about the license texinfo files
Karl Berry <karl@freefriends.org>
parents:
6989
diff
changeset
|
415 |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
416 @node Particular Modules |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
417 @chapter Particular Modules |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
418 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
419 @menu |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
420 * Quoting:: |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
421 * ctime:: |
|
7778
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
422 * error and progname:: |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
423 * gcd:: |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
424 * inet_ntoa:: |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
425 * Regular expressions:: |
|
8272
fd48e35f4e5e
New modules relocatable, relocatable-lib, relocatable-script.
Bruno Haible <bruno@clisp.org>
parents:
7778
diff
changeset
|
426 * Supporting Relocation:: |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
427 @end menu |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
428 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
429 @include quote.texi |
|
7778
1736cdb7eda4
document error/progname interaction
Karl Berry <karl@freefriends.org>
parents:
7618
diff
changeset
|
430 @include error.texi |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
431 @include ctime.texi |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
432 @include gcd.texi |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
433 @include inet_ntoa.texi |
|
8272
fd48e35f4e5e
New modules relocatable, relocatable-lib, relocatable-script.
Bruno Haible <bruno@clisp.org>
parents:
7778
diff
changeset
|
434 @include relocatable-maint.texi |
|
7546
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
435 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
436 @node Regular expressions |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
437 @section Regular expressions |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
438 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
439 Gnulib supports many different types of regular expressions; although |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
440 the underlying features are the same or identical, the syntax used |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
441 varies. The descriptions given here for the different types are |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
442 generated automatically. |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
443 |
|
de9055fd713b
Split the chapter "Gnulib" into 3 chapters "Introduction",
Bruno Haible <bruno@clisp.org>
parents:
7334
diff
changeset
|
444 @include regexprops-generic.texi |
|
5256
e23bd8e9d368
import sections from Simon
Karl Berry <karl@freefriends.org>
parents:
5239
diff
changeset
|
445 |
| 5239 | 446 |
| 447 @node Copying This Manual | |
| 448 @appendix Copying This Manual | |
| 449 | |
| 450 @menu | |
| 451 * GNU Free Documentation License:: License for copying this manual. | |
| 452 @end menu | |
| 453 | |
| 454 @include fdl.texi | |
| 455 | |
| 456 | |
| 457 @node Index | |
| 458 @unnumbered Index | |
| 459 | |
| 460 @printindex cp | |
| 461 | |
| 462 @bye |