Penguin
Blame: kernel-pkg.conf(5)
EditPageHistoryDiffInfoLikePages
Annotated edit history of kernel-pkg.conf(5) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 KERNEL-PKG.CONF
2 !!!KERNEL-PKG.CONF
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 FILES
7 SEE ALSO
8 BUGS
9 AUTHOR
10 ----
11 !!NAME
12
13
14 kernel-pkg.conf - site wide configuration file for make-kpkg
15 !!SYNOPSIS
16
17
18 ''/etc/kernel-pkg.conf'' or
19 ''~/.kernel-pkg.conf''
20 !!DESCRIPTION
21
22
23 The file ''/etc/kernel-pkg.conf'' or
24 ''~/.kernel-pkg.conf'' is actually a __Makefile__
25 snippet included during the kernel packages build process,
26 and hence you may put any legal Makefile directive in that
27 file (just make very sure you know what you are doing). If
28 the per user configuration file ''~/.kernel-pkg.conf''
29 exists, it is laoded in favour of the system wide
30 confguration file ''/etc/kernel-pkg.conf.''
31
32
33 All the variables have reasonable default values, and maybe
34 overridden on a per run or a per individual basis by using
35 environment variables. Some of the variables can further be
36 overridden by options to __make-kpkg.__
37
38
39 At the moment, the user modifiable variables supported
40 are:
41
42
43 __maintainer__
44
45
46 Local kernel-* package maintainer. Set up at package
47 installation by the ''postinst.'' Can be overridden by
48 the environment variable __KPKG_MAINTAINER.__ Please note
49 that any apostrophes
50 __
51
52
53 __email__
54
55
56 The email address of that person. Set up at package
57 installation by the ''postinst.'' Can be overridden by
58 the environment variable __KPKG_EMAIL.__
59
60
61 __pgp__
62
63
64 Name to search for in the pgp database __iff__ separate
65 modules (like pcmcia etc) are being built in
66 ''/usr/src/modules/.'' Can be overridden by the
67 environment variable __PGP_SIGNATURE,__ and is overridden
68 (again) by the ''--pgpsign'' option of __make-kpkg.__
69 Defaults to ''maintainer.'' (Optional)
70
71
72 __debian__
73
74
75 The Debian revision of the kernel packages. Can be
76 overridden by the environment variable
77 __DEBIAN_REVISION,__ and is overridden (again) by the
78 ''--revision'' option of __make-kpkg.__ Defaults to
79 ''1.0.0.Custom'' (Optional)
80
81
82 __debian_revision_mandatory__
83
84
85 Normally unset. Ifthis, or the environment variable
86 __DEBIAN_REVISION_MANDATORY__ are set, then not providing
87 a debian revision results in an error (and __make-kpkg__
88 shall not provide a default vvalue of
89 1.0.0.Custom)
90
91
92 __image_in_boot__
93
94
95 Set to True if you want the kernel image ''vmlinuz'' in
96 ''/boot'' rather than the default ''/.'' Can be
97 overridden by the environment variable __IMAGE_IN_BOOT.__
98 Defaults to undefined. (Optional)
99
100
101 __kimage__
102
103
104 The kernel image type (i.e. zImage or bzImage). Can be
105 overridden from the environment variable __IMAGE_TYPE,__
106 and is overridden (again) by the options ''--zimage'' or
107 ''--bzimage'' of __make-kpkg.__ Defaults to
108 ''bzImage.'' (Optional)
109
110
111 __no_symlinks__
112
113
114 Whether to use symlinks to the ''image'' file. Can be
115 overridden by the environment variable __NO_SYMLINK__
116 Mutualy exclusive to ''reverse_symlinks.'' Can be used
117 with ''image_in_boot.'' The image is placed in vmlinuz
118 (instead of /boot/vmlinuz-X.X.XX). The old vmlinuz is moved
119 to vmlinuz.old unconditionally. (Normally, that is only done
120 if the version of the new image differes from the old one).
121 This restricts you to two images, unless you take additional
122 action and save copies of older images. This is for people
123 who have ''/boot'' on a system that does not use symbolic
124 links (and say, they use loadlin as a boot loader). This is
125 a Hack. Defaults to undefined (optional)
126
127
128 __reverse_symlinks__
129
130
131 Whether to use reverse symlinks (that is, the real file is
132 the one without the version number, and the numberd version
133 is the link) to the ''image'' file. Can be overridden by
134 the environment variable __REVERSE_SYMLINK__ Mutualy
135 exclusive to ''no_symlinks.'' Can be used with
136 ''image_in_boot.'' Just like ''no_symlinks,'' except
137 that the /boot/vmlinuz-X.XX is symlinked to the real new
138 image, vmlinuz. This, too, restricts you to just two images
139 unless further action is taken. The older symlinks are left
140 dangling. This is for people with ''/boot'' on umsdos,
141 and who can't see the link in dos, but do want to know the
142 image version when in Linux. This is a Hack. Defaults to
143 undefined. (optional)
144
145
146 __patch_the_kernel__
147
148
149 This is an experts only variable. If set to YES (ENV
150 variable __PATCH_THE_KERNEL__ overrides this), the build
151 process causes run-parts to be run over
152 ''/usr/src/kernel-patches/$(architecture)/apply'' and
153 (hopefully) reverses the process during clean by running
154 run-parts over
155 ''/usr/src/kernel-patches/$(architecture)/unpatch.'' The
156 special architecture all is used for arch independent
157 patches.
158
159
160 __config_target__
161
162
163 What type of configure step to do. Defaults to oldconfig,
164 which is good for non-interactive (or minimally interactive)
165 runs. If you are setting patch_the_kernel to YES and some of
166 the patches change what configuration settings are
167 available, then you may wish to set this to something else
168 (like menuconfig or xconfig). (ENV variable
169 __CONFIG_TARGET__ overrides this setting.) If the value
170 of config_target is other than config, oldconfig, menuconfig
171 or xconfig then it is reset to oldconfig.
172
173
174 __use_saved_config__
175
176
177 This is an experts only variable. If set to NO (ENV variable
178 __USE_SAVED_CONFIG__ overrides this), the file
179 .config.save in the top level directory is
180 ignored.
181
182
183 __root_cmd__
184
185
186 This should be set to a means of gaining superuser access
187 (for example, ''`sudo''' or as needed by
188 __dpkg-buildpackages'__ -r option. The environment
189 variable __ROOT_CMD__ overrides this. The environment
190 variable __UNSIGN_SOURCE__ adds to this command an option
191 to have dpkg-buildpackage not sign the source, similarily,
192 the environment variable __UNSIGN_CHANGELOG__ adds to
193 this command an option to have dpkg-buildpackage not sign
194 the changelog.
195
196
197 __delete_build_link__
198
199
200 If set to YES, the symbolic link
201 ''/lib/modules/$VERSION/build'' shall be removed from the
202 resulting .deb package. The environment variable
203 __DELETE_BUILD_LINK__ overrides this.
204
205
206 __do_clean__
207
208
209 Set to anything but YES, this shall forego the make clean
210 done in the kernel source tree after building the kernel
211 image package. The environment variable __CLEAN_SOURCE__
212 overrides this.
213
214
215 __extra_docs__
216
217
218 This variable should be set to the path of any extra
219 documentation that should be installed in
220 ''/usr/share/doc/kernel-image-X.X.XX/'' directory. There
221 is no checking for name conflicts, and the files are not
222 compressed. Hence, if you want the files to be compressed,
223 please precompress it and provide the path of the compressed
224 file. The environment variable __EXTRA_DOCS__ overrides
225 this, and would most likely be how extra documentation is
226 specified.
227
228
229 __make_libc_headers__
230
231
232 This is meant to be used by the ''libc6'' maintainer,
233 when he compiles ''libc6,'' to also package up the
234 corresponding headers. __DO NOT SET THIS__ unless you
235 know what you are doing, since a mismatch between the
236 headers you package and ''libc6'' may well create a
237 subtle instablity in all code compiled on your machine. You
238 have been warned. The environment variable
239 __MAKE_LIBC_HEADERS__ overrides this.
240
241
242 __CONCURRENCY_LEVEL__
243
244
245 If defined, this variable sets the concurrency level of make
246 used to compile the kenel and the modules set using
247 ''-j'' flags to the sub make in the __build__ target
248 of __make-kpkg.__ Should be a (small) integer, if
249 used.
250
251
252 __ARCH_IN_NAME__
253
254
255 If defined, this variable causes __make-kpkg__ to use an
256 extended name for the kernel image package by embedding the
257 subarchitecture in the image name, so one could write a
258 script to create multiple subarchitectures one after the
259 other. __Please note__ that only the package ''name''
260 is affected, not module locations etc.
261
262
263 __CONFDIR__
264
265
266 This variable should be set to a directory which contains
267 architecture specific ''.config'' files (look at
268 ''/usr/share/kernel-package/Config'' for examples). This
269 is useful for people who need to compile for several
270 architectures. Defaults to
271 ''/usr/share/kernel-package/Config''
272
273
274 __IMAGEDIR__
275
276
277 If you want the image to be stored elsewhere than
278 ''/boot'' set this variable to the dir where you want the
279 image. This may be of help to __loadlin__ users. Defaults
280 to ''/boot.''
281
282
283 __MODULE_LOC__
284
285
286 Set this variable, either in the environment or in the
287 config file, to point to the location where the add-on
288 modules are located. Defaults to
289 ''/usr/src/modules''
290
291
292 __CONFDIR__
293
294
295 Set this variable, either in the environment or in the
296 config file, to point to the location where the kernel
297 config files are located. Defaults to
298 ''/usr/share/kernel-package/Config''
299
300
301 __PATCH_DIR__
302
303
304 Set this variable, either in the environment or in the
305 config file, to point to the location where the add-on
306 kernel patches are located. Defaults to
307 ''/usr/src/kernel-patches/ARCHITECTURE''
308
309
310 __ALL_PATCH_DIR__
311
312
313 Set this variable, either in the environment or in the
314 config file, to point to the location where the add-on arch
315 independent kernel patches are located. Defaults to
316 ''/usr/src/kernel-patches/all''
317
318
319 The value of a variable can be set so:
320
321
322 a)
323
324
325 Defaults exist in the rules file. These are the values used
326 if no customization is done.
327
328
329 b)
330
331
332 Variables can be set in the config file
333 ''/etc/kernel-pkg.conf.'' These values override the
334 defaults.
335
336
337 c)
338
339
340 Variables can also be set by setting a corresponding
341 environment variable. These values override the config file
342 and the defaults.
343
344
345 d)
346
347
348 Using __make-kpkg__ options, or, if using the rules file
349 directly, on command line__
350 # xxx/rules DEBIAN_REVISION=2.0a kernel_image__
351 This overrides all the above methods.
352 !!FILES
353
354
355 The file described here is ''/etc/kernel-pkg.conf.'' or
356 ''~/.kernel-pkg.conf.''
357 !!SEE ALSO
358
359
4 perry 360 make-kpkg(1), __kernel-img.conf__(5),
1 perry 361 make(1), __The GNU Make manual.__
362 !!BUGS
363
364
365 There are no bugs. Any resemblance thereof is delirium.
366 Really.
367 !!AUTHOR
368
369
370 This manual page was written by Manoj Srivastava
371 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.