docs/manual/adding-packages-tips.txt

1 // -*- mode:doc; -*-
6 [[package-name-variable-relation]]
22   itself (e.g.: +package/foo-bar_boo/foo-bar_boo.mk+);
25   +foo-bar_boo+);
27 * the config entry is the upper case _package name_ with `.` and `-`
32   with `.` and `-` characters substituted with `_` (e.g.:
35 [[check-package]]
38 Buildroot provides a script in +utils/check-package+ that checks new or
47 To use it, run the +check-package+ script, by telling which files you
50 ----
51 $ ./utils/check-package package/new-package/*
52 ----
56 ----
57 $ cd package/new-package/
58 $ check-package *
59 ----
61 The tool can also be used for packages in a br2-external:
63 ----
64 $ check-package -b /path/to/br2-ext-tree/package/my-package/*
65 ----
67 [[testing-package]]
80 Buildroot provides a script in +utils/test-pkg+ that uses the same base
89 ----
92 ----
98 ----
103 ----
105 Then run the +test-pkg+ script, by telling it what config snippet to use
108 ----
109 $ ./utils/test-pkg -c libcurl.config -p libcurl
110 ----
112 By default, +test-pkg+ will build your package against a subset of the
115 subset. If you want to test all toolchains, pass the +-a+ option. Note
122 ----
123 $ ./utils/test-pkg -c libcurl.config -p libcurl
124                 armv5-ctng-linux-gnueabi [ 1/11]: OK
125               armv7-ctng-linux-gnueabihf [ 2/11]: OK
126                         br-aarch64-glibc [ 3/11]: SKIPPED
127                            br-arcle-hs38 [ 4/11]: SKIPPED
128                             br-arm-basic [ 5/11]: FAILED
129                   br-arm-cortex-a9-glibc [ 6/11]: OK
130                    br-arm-cortex-a9-musl [ 7/11]: FAILED
131                    br-arm-cortex-m4-full [ 8/11]: OK
132                              br-arm-full [ 9/11]: OK
133                     br-arm-full-nothread [10/11]: FAILED
134                       br-arm-full-static [11/11]: OK
135 11 builds, 2 skipped, 2 build failed, 1 legal-info failed
136 ----
146   the output build directory (+~/br-test-pkg/TOOLCHAIN_NAME/+ by
151 ** the legal-info failed,
155 When there are failures, you can just re-run the script with the same
157 re-build the package specified with +-p+ for all toolchains, without
158 the need to re-build all the dependencies of that package.
160 The +test-pkg+ script accepts a few options, for which you can get some
163 ----
164 $ ./utils/test-pkg -h
165 ----
167 [[github-download-url]]
175 ------------------------
179 ------------------------
182 - The FOO_VERSION can either be a tag or a commit ID.
183 - The tarball name generated by github matches the default one from
184   Buildroot (e.g.: +foo-f6fb6654af62045239caed5950bc6c7971965e60.tar.gz+),
186 - When using a commit ID as version, you should use the full 40 hex characters.
187 - When the tag contains a prefix such as +v+ in +v1.0+, then the
191   against http://www.release-monitoring.org/[release-monitoring.org]
205 - If it looks like the image above then it was uploaded by the
207   'mongrel2-v1.9.2.tar.bz2') to specify +FOO_SITE+, and not use the
210 - On the other hand, if there's is *only* the "Source code" link, then
214 [[gitlab-download-url]]
218 xref:github-download-url[], Buildroot also provides the +gitlab+ macro
220 auto-generated tarballs produced by Gitlab, either for specific tags
223 ------------------------
227 ------------------------
233 ------------------------
237 FOO_SOURCE = foo-$(FOO_VERSION).tar.bz2
238 ------------------------