2 // vim: set syntax=asciidoc:
4 Infrastructure for packages with specific build systems
5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 By 'packages with specific build systems' we mean all the packages
8 whose build system is not one of the standard ones, such as
9 'autotools' or 'CMake'. This typically includes packages whose build
10 system is based on hand-written Makefiles or shell scripts.
12 [[generic-package-tutorial]]
14 +generic-package+ Tutorial
15 ^^^^^^^^^^^^^^^^^^^^^^^^^^
17 ------------------------------
18 01: ################################################################################
22 05: ################################################################################
24 07: LIBFOO_VERSION = 1.0
25 08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
26 09: LIBFOO_SITE = http://www.foosoftware.org/download
27 10: LIBFOO_LICENSE = GPLv3+
28 11: LIBFOO_LICENSE_FILES = COPYING
29 12: LIBFOO_INSTALL_STAGING = YES
30 13: LIBFOO_CONFIG_SCRIPTS = libfoo-config
31 14: LIBFOO_DEPENDENCIES = host-libaaa libbbb
33 16: define LIBFOO_BUILD_CMDS
34 17: $(MAKE) CC="$(TARGET_CC)" LD="$(TARGET_LD)" -C $(@D) all
37 20: define LIBFOO_INSTALL_STAGING_CMDS
38 21: $(INSTALL) -D -m 0755 $(@D)/libfoo.a $(STAGING_DIR)/usr/lib/libfoo.a
39 22: $(INSTALL) -D -m 0644 $(@D)/foo.h $(STAGING_DIR)/usr/include/foo.h
40 23: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(STAGING_DIR)/usr/lib
43 26: define LIBFOO_INSTALL_TARGET_CMDS
44 27: $(INSTALL) -D -m 0755 $(@D)/libfoo.so* $(TARGET_DIR)/usr/lib
45 28: $(INSTALL) -d -m 0755 $(TARGET_DIR)/etc/foo.d
48 31: define LIBFOO_DEVICES
49 32: /dev/foo c 666 0 0 42 0 - - -
52 35: define LIBFOO_PERMISSIONS
53 36: /bin/foo f 4755 0 0 - - - - -
56 39: define LIBFOO_USERS
57 40: foo -1 libfoo -1 * - - - LibFoo daemon
60 43: $(eval $(generic-package))
61 --------------------------------
63 The Makefile begins on line 7 to 11 with metadata information: the
64 version of the package (+LIBFOO_VERSION+), the name of the
65 tarball containing the package (+LIBFOO_SOURCE+) (xz-ed tarball recommended)
66 the Internet location at which the tarball can be downloaded from
67 (+LIBFOO_SITE+), the license (+LIBFOO_LICENSE+) and file with the
68 license text (+LIBFOO_LICENSE_FILES+). All variables must start with
69 the same prefix, +LIBFOO_+ in this case. This prefix is always the
70 uppercased version of the package name (see below to understand where
71 the package name is defined).
73 On line 12, we specify that this package wants to install something to
74 the staging space. This is often needed for libraries, since they must
75 install header files and other development files in the staging space.
76 This will ensure that the commands listed in the
77 +LIBFOO_INSTALL_STAGING_CMDS+ variable will be executed.
79 On line 13, we specify that there is some fixing to be done to some
80 of the 'libfoo-config' files that were installed during
81 +LIBFOO_INSTALL_STAGING_CMDS+ phase.
82 These *-config files are executable shell script files that are
83 located in '$(STAGING_DIR)/usr/bin' directory and are executed
84 by other 3rd party packages to find out the location and the linking
85 flags of this particular package.
87 The problem is that all these *-config files by default give wrong,
88 host system linking flags that are unsuitable for cross-compiling.
90 For example: '-I/usr/include' instead of '-I$(STAGING_DIR)/usr/include'
91 or: '-L/usr/lib' instead of '-L$(STAGING_DIR)/usr/lib'
93 So some sed magic is done to these scripts to make them give correct
95 The argument to be given to +LIBFOO_CONFIG_SCRIPTS+ is the file name(s)
96 of the shell script(s) needing fixing. All these names are relative to
97 '$(STAGING_DIR)/usr/bin' and if needed multiple names can be given.
99 In addition, the scripts listed in +LIBFOO_CONFIG_SCRIPTS+ are removed
100 from +$(TARGET_DIR)/usr/bin+, since they are not needed on the target.
102 .Config script: 'divine' package
103 ================================
104 Package divine installs shell script '$(STAGING_DIR)/usr/bin/divine-config'.
106 So its fixup would be:
108 --------------------------------
109 DIVINE_CONFIG_SCRIPTS = divine-config
110 --------------------------------
111 ================================
113 .Config script: 'imagemagick' package:
114 ================================
115 Package imagemagick installs the following scripts:
116 '$(STAGING_DIR)/usr/bin/{Magick,Magick++,MagickCore,MagickWand,Wand}-config'
118 So it's fixup would be:
120 --------------------------------
121 IMAGEMAGICK_CONFIG_SCRIPTS = \
122 Magick-config Magick++-config \
123 MagickCore-config MagickWand-config Wand-config
124 --------------------------------
125 ================================
127 On line 14, we specify the list of dependencies this package relies
128 on. These dependencies are listed in terms of lower-case package names,
129 which can be packages for the target (without the +host-+
130 prefix) or packages for the host (with the +host-+) prefix).
131 Buildroot will ensure that all these packages are built and installed
132 'before' the current package starts its configuration.
134 The rest of the Makefile, lines 16..29, defines what should be done
135 at the different steps of the package configuration, compilation and
137 +LIBFOO_BUILD_CMDS+ tells what steps should be performed to
138 build the package. +LIBFOO_INSTALL_STAGING_CMDS+ tells what
139 steps should be performed to install the package in the staging space.
140 +LIBFOO_INSTALL_TARGET_CMDS+ tells what steps should be
141 performed to install the package in the target space.
143 All these steps rely on the +$(@D)+ variable, which
144 contains the directory where the source code of the package has been
147 On line 31..33, we define a device-node file used by this package
150 On line 35..37, we define the permissions to set to specific files
151 installed by this package (+LIBFOO_PERMISSIONS+).
153 On lines 39..41, we define a user that is used by this package (eg.
154 to run a daemon as non-root) (+LIBFOO_USERS+).
156 Finally, on line 43, we call the +generic-package+ function, which
157 generates, according to the variables defined previously, all the
158 Makefile code necessary to make your package working.
160 [[generic-package-reference]]
162 +generic-package+ Reference
163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
165 There are two variants of the generic target. The +generic-package+ macro is
166 used for packages to be cross-compiled for the target. The
167 +host-generic-package+ macro is used for host packages, natively compiled
168 for the host. It is possible to call both of them in a single +.mk+
169 file: once to create the rules to generate a target
170 package and once to create the rules to generate a host package:
172 ----------------------
173 $(eval $(generic-package))
174 $(eval $(host-generic-package))
175 ----------------------
177 This might be useful if the compilation of the target package requires
178 some tools to be installed on the host. If the package name is
179 +libfoo+, then the name of the package for the target is also
180 +libfoo+, while the name of the package for the host is
181 +host-libfoo+. These names should be used in the DEPENDENCIES
182 variables of other packages, if they depend on +libfoo+ or
185 The call to the +generic-package+ and/or +host-generic-package+ macro *must* be
186 at the end of the +.mk+ file, after all variable definitions.
188 For the target package, the +generic-package+ uses the variables defined by
189 the .mk file and prefixed by the uppercased package name:
190 +LIBFOO_*+. +host-generic-package+ uses the +HOST_LIBFOO_*+ variables. For
191 'some' variables, if the +HOST_LIBFOO_+ prefixed variable doesn't
192 exist, the package infrastructure uses the corresponding variable
193 prefixed by +LIBFOO_+. This is done for variables that are likely to
194 have the same value for both the target and host packages. See below
197 The list of variables that can be set in a +.mk+ file to give metadata
198 information is (assuming the package name is +libfoo+) :
200 * +LIBFOO_VERSION+, mandatory, must contain the version of the
201 package. Note that if +HOST_LIBFOO_VERSION+ doesn't exist, it is
202 assumed to be the same as +LIBFOO_VERSION+. It can also be a
203 revision number, branch or tag for packages that are fetched
204 directly from their revision control system. +
206 +LIBFOO_VERSION = 0.1.2+ +
207 +LIBFOO_VERSION = cb9d6aa9429e838f0e54faa3d455bcbab5eef057+ +
208 +LIBFOO_VERSION = stable+
210 * +LIBFOO_SOURCE+ may contain the name of the tarball of
211 the package. If +HOST_LIBFOO_SOURCE+ is not specified, it
212 defaults to +LIBFOO_SOURCE+. If none are specified, then
213 the value is assumed to be
214 +packagename-$(LIBFOO_VERSION).tar.gz+. +
215 Example: +LIBFOO_SOURCE = foobar-$(LIBFOO_VERSION).tar.bz2+
217 * +LIBFOO_PATCH+ may contain a space-separated list of patch file
218 names, that will be downloaded from the same location as the tarball
219 indicated in +LIBFOO_SOURCE+, and then applied to the package source
220 code. If +HOST_LIBFOO_PATCH+ is not specified, it defaults to
221 +LIBFOO_PATCH+. Note that patches that are included in Buildroot
222 itself use a different mechanism: all files of the form
223 +<packagename>-*.patch+ present in the package directory inside
224 Buildroot will be applied to the package after extraction (see
225 xref:patch-policy[patching a package]). Finally, patches listed in
226 the +LIBFOO_PATCH+ variable are applied _before_ the patches stored
227 in the Buildroot package directory.
229 * +LIBFOO_SITE+ provides the location of the package, which can be a
230 URL or a local filesystem path. HTTP, FTP and SCP are supported URL
231 types for retrieving package tarballs. Git, Subversion, Mercurial,
232 and Bazaar are supported URL types for retrieving packages directly
233 from source code management systems. A filesystem path may be used
234 to specify either a tarball or a directory containing the package
235 source code. See +LIBFOO_SITE_METHOD+ below for more details on how
237 Note that SCP URLs should be of the form
238 +scp://[user@]host:filepath+, and that filepath is relative to the
239 user's home directory, so you may want to prepend the path with a
240 slash for absolute paths:
241 +scp://[user@]host:/absolutepath+. +
242 If +HOST_LIBFOO_SITE+ is not specified, it defaults to
245 +LIBFOO_SITE=http://www.libfoosoftware.org/libfoo+ +
246 +LIBFOO_SITE=http://svn.xiph.org/trunk/Tremor/+ +
247 +LIBFOO_SITE=git://github.com/kergoth/tslib.git+ +
248 +LIBFOO_SITE=/opt/software/libfoo.tar.gz+ +
249 +LIBFOO_SITE=$(TOPDIR)/../src/libfoo/+
251 * +LIBFOO_SITE_METHOD+ determines the method used to fetch or copy the
252 package source code. In many cases, Buildroot guesses the method
253 from the contents of +LIBFOO_SITE+ and setting +LIBFOO_SITE_METHOD+
254 is unnecessary. When +HOST_LIBFOO_SITE_METHOD+ is not specified, it
255 defaults to the value of +LIBFOO_SITE_METHOD+. +
256 The possible values of +LIBFOO_SITE_METHOD+ are:
257 ** +wget+ for normal FTP/HTTP downloads of tarballs. Used by
258 default when +LIBFOO_SITE+ begins with +http://+, +https://+ or
260 ** +scp+ for downloads of tarballs over SSH with scp. Used by
261 default when +LIBFOO_SITE+ begins with +scp://+.
262 ** +svn+ for retrieving source code from a Subversion repository.
263 Used by default when +LIBFOO_SITE+ begins with +svn://+. When a
264 +http://+ Subversion repository URL is specified in
265 +LIBFOO_SITE+, one 'must' specify +LIBFOO_SITE_METHOD=svn+.
266 Buildroot performs a checkout which is preserved as a tarball in
267 the download cache; subsequent builds use the tarball instead of
268 performing another checkout.
269 ** +cvs+ for retrieving source code from a CVS repository.
270 Used by default when +LIBFOO_SITE+ begins with +cvs://+.
271 The downloaded source code is cached as with the +svn+ method.
272 Only anonymous pserver mode is supported.
273 +LIBFOO_SITE+ 'must' contain the source URL as well as the remote
274 repository directory. The module is the package name.
275 +LIBFOO_VERSION+ is 'mandatory' and 'must' be a timestamp.
276 ** +git+ for retrieving source code from a Git repository. Used by
277 default when +LIBFOO_SITE+ begins with +git://+. The downloaded
278 source code is cached as with the +svn+
280 ** +hg+ for retrieving source code from a Mercurial repository. One
281 'must' specify +LIBFOO_SITE_METHOD=hg+ when +LIBFOO_SITE+
282 contains a Mercurial repository URL. The downloaded source code
283 is cached as with the +svn+ method.
284 ** +bzr+ for retrieving source code from a Bazaar repository. Used
285 by default when +LIBFOO_SITE+ begins with +bzr://+. The
286 downloaded source code is cached as with the +svn+ method.
287 ** +file+ for a local tarball. One should use this when
288 +LIBFOO_SITE+ specifies a package tarball as a local filename.
289 Useful for software that isn't available publicly or in version
291 ** +local+ for a local source code directory. One should use this
292 when +LIBFOO_SITE+ specifies a local directory path containing
293 the package source code. Buildroot copies the contents of the
294 source directory into the package's build directory.
296 * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
297 name) that are required for the current target package to
298 compile. These dependencies are guaranteed to be compiled and
299 installed before the configuration of the current package starts. In
300 a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
301 the current host package.
303 * +LIBFOO_INSTALL_STAGING+ can be set to +YES+ or +NO+ (default). If
304 set to +YES+, then the commands in the +LIBFOO_INSTALL_STAGING_CMDS+
305 variables are executed to install the package into the staging
308 * +LIBFOO_INSTALL_TARGET+ can be set to +YES+ (default) or +NO+. If
309 set to +YES+, then the commands in the +LIBFOO_INSTALL_TARGET_CMDS+
310 variables are executed to install the package into the target
313 * +LIBFOO_CONFIG_SCRIPTS+ lists the names of the files in
314 '$(STAGING_DIR)/usr/bin' that need some special fixing to make them
315 cross-compiling friendly. Multiple file names separated by space can
316 be given and all are relative to '$(STAGING_DIR)/usr/bin'. The files
317 listed in +LIBFOO_CONFIG_SCRIPTS+ are also removed from
318 +$(TARGET_DIR)/usr/bin+ since they are not needed on the target.
320 * +LIBFOO_DEVICES+ lists the device files to be created by Buildroot
321 when using the static device table. The syntax to use is the
322 makedevs one. You can find some documentation for this syntax in the
323 xref:makedev-syntax[]. This variable is optional.
325 * +LIBFOO_PERMISSIONS+ lists the changes of permissions to be done at
326 the end of the build process. The syntax is once again the makedevs one.
327 You can find some documentation for this syntax in the xref:makedev-syntax[].
328 This variable is optional.
330 * +LIBFOO_USERS+ lists the users to create for this package, if it installs
331 a program you want to run as a specific user (eg. as a daemon, or as a
332 cron-job). The syntax is similar in spirit to the makedevs one, and is
333 described in the xref:makeuser-syntax[]. This variable is optional.
335 * +LIBFOO_LICENSE+ defines the license (or licenses) under which the package
337 This name will appear in the manifest file produced by +make legal-info+.
338 If the license appears in xref:legal-info-list-licenses[the following list],
339 use the same string to make the manifest file uniform.
340 Otherwise, describe the license in a precise and concise way, avoiding
341 ambiguous names such as +BSD+ which actually name a family of licenses.
342 This variable is optional. If it is not defined, +unknown+ will appear in
343 the +license+ field of the manifest file for this package.
345 * +LIBFOO_LICENSE_FILES+ is a space-separated list of files in the package
346 tarball that contain the license(s) under which the package is released.
347 +make legal-info+ copies all of these files in the +legal-info+ directory.
348 See xref:legal-info[] for more information.
349 This variable is optional. If it is not defined, a warning will be produced
350 to let you know, and +not saved+ will appear in the +license files+ field
351 of the manifest file for this package.
353 * +LIBFOO_REDISTRIBUTE+ can be set to +YES+ (default) or +NO+ to indicate if
354 the package source code is allowed to be redistributed. Set it to +NO+ for
355 non-opensource packages: Buildroot will not save the source code for this
356 package when collecting the +legal-info+.
358 * +LIBFOO_FLAT_STACKSIZE+ defines the stack size of an application built into
359 the FLAT binary format. The application stack size on the NOMMU architecture
360 processors can't be enlarged at run time. The default stack size for the
361 FLAT binary format is only 4k bytes. If the application consumes more stack,
362 append the required number here.
364 The recommended way to define these variables is to use the following
367 ----------------------
368 LIBFOO_VERSION = 2.32
369 ----------------------
371 Now, the variables that define what should be performed at the
372 different steps of the build process.
374 * +LIBFOO_EXTRACT_CMDS+ lists the actions to be performed to extract
375 the package. This is generally not needed as tarballs are
376 automatically handled by Buildroot. However, if the package uses a
377 non-standard archive format, such as a ZIP or RAR file, or has a
378 tarball with a non-standard organization, this variable allows to
379 override the package infrastructure default behavior.
381 * +LIBFOO_CONFIGURE_CMDS+ lists the actions to be performed to
382 configure the package before its compilation.
384 * +LIBFOO_BUILD_CMDS+ lists the actions to be performed to
387 * +HOST_LIBFOO_INSTALL_CMDS+ lists the actions to be performed
388 to install the package, when the package is a host package. The
389 package must install its files to the directory given by
390 +$(HOST_DIR)+. All files, including development files such as
391 headers should be installed, since other packages might be compiled
392 on top of this package.
394 * +LIBFOO_INSTALL_TARGET_CMDS+ lists the actions to be
395 performed to install the package to the target directory, when the
396 package is a target package. The package must install its files to
397 the directory given by +$(TARGET_DIR)+. Only the files required for
398 'execution' of the package have to be
399 installed. Header files, static libraries and documentation will be
400 removed again when the target filesystem is finalized.
402 * +LIBFOO_INSTALL_STAGING_CMDS+ lists the actions to be
403 performed to install the package to the staging directory, when the
404 package is a target package. The package must install its files to
405 the directory given by +$(STAGING_DIR)+. All development files
406 should be installed, since they might be needed to compile other
409 * +LIBFOO_CLEAN_CMDS+, lists the actions to perform to clean up
410 the build directory of the package.
412 * +LIBFOO_UNINSTALL_TARGET_CMDS+ lists the actions to
413 uninstall the package from the target directory +$(TARGET_DIR)+
415 * +LIBFOO_UNINSTALL_STAGING_CMDS+ lists the actions to
416 uninstall the package from the staging directory +$(STAGING_DIR)+.
418 * +LIBFOO_INSTALL_INIT_SYSV+ and +LIBFOO_INSTALL_INIT_SYSTEMD+ list the
419 actions to install init scripts either for the systemV-like init systems
420 (busybox, sysvinit, etc.) or for the systemd units. These commands
421 will be run only when the relevant init system is installed (i.e. if
422 systemd is selected as the init system in the configuration, only
423 +LIBFOO_INSTALL_INIT_SYSTEMD+ will be run).
425 The preferred way to define these variables is:
427 ----------------------
428 define LIBFOO_CONFIGURE_CMDS
433 ----------------------
435 In the action definitions, you can use the following variables:
437 * +$(@D)+, which contains the directory in which the package source
438 code has been uncompressed.
440 * +$(TARGET_CC)+, +$(TARGET_LD)+, etc. to get the target
441 cross-compilation utilities
443 * +$(TARGET_CROSS)+ to get the cross-compilation toolchain prefix
445 * Of course the +$(HOST_DIR)+, +$(STAGING_DIR)+ and +$(TARGET_DIR)+
446 variables to install the packages properly.
448 The last feature of the generic infrastructure is the ability to add
449 hooks. These define further actions to perform after existing steps.
450 Most hooks aren't really useful for generic packages, since the +.mk+
451 file already has full control over the actions performed in each step
452 of the package construction. The hooks are more useful for packages
453 using the autotools infrastructure described below. However, since
454 they are provided by the generic infrastructure, they are documented
455 here. The exception is +LIBFOO_POST_PATCH_HOOKS+. Patching the
456 package and producing legal info are not user definable, so
457 +LIBFOO_POST_PATCH_HOOKS+ and +LIBFOO_POST_LEGAL_INFO_HOOKS+ are
458 useful for generic packages.
460 The following hook points are available:
462 * +LIBFOO_POST_DOWNLOAD_HOOKS+
463 * +LIBFOO_POST_EXTRACT_HOOKS+
464 * +LIBFOO_PRE_PATCH_HOOKS+
465 * +LIBFOO_POST_PATCH_HOOKS+
466 * +LIBFOO_PRE_CONFIGURE_HOOKS+
467 * +LIBFOO_POST_CONFIGURE_HOOKS+
468 * +LIBFOO_POST_BUILD_HOOKS+
469 * +LIBFOO_POST_INSTALL_HOOKS+ (for host packages only)
470 * +LIBFOO_POST_INSTALL_STAGING_HOOKS+ (for target packages only)
471 * +LIBFOO_POST_INSTALL_TARGET_HOOKS+ (for target packages only)
472 * +LIBFOO_POST_LEGAL_INFO_HOOKS+
474 These variables are 'lists' of variable names containing actions to be
475 performed at this hook point. This allows several hooks to be
476 registered at a given hook point. Here is an example:
478 ----------------------
479 define LIBFOO_POST_PATCH_FIXUP
484 LIBFOO_POST_PATCH_HOOKS += LIBFOO_POST_PATCH_FIXUP
485 ----------------------