pktsurf/smlinux
1
1
Fork 0
Code Issues 1 Pull requests Wiki Activity

Replaced upper case variables with lower case and added more explanation in sample build files

Browse source
This commit is contained in:
SMLinux 2022-02-17 12:31:12 +05:30
parent b5fb835cf0
commit e886d7440b
2 changed files with 63 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
buildsamples/sample.SMBuild
View file

@ -1,16 +1,17 @@
APP= app=
VERSION= version=
BUILD=1sml build=1sml
HOMEPAGE="" homepage=""
DOWNLOAD="" download=""
REQUIRES="" desc=""
requires=""
build() { build() {
mkandenterbuilddir mkandenterbuilddir
rm -rf $APP-$VERSION rm -rf $app-$version
tar xf $SRCDIR/$APP-$VERSION.tar.?z* tar xf $srcdir/$app-$version.tar.?z*
cd $APP-$VERSION cd $app-$version
fixbuilddirpermissions fixbuilddirpermissions
./configure \ ./configure \
@ -18,9 +19,9 @@ build() {
--sysconfdir=/etc --sysconfdir=/etc
make make
make install DESTDIR=$PKG make install DESTDIR=$pkg
cp LICENSE $PKGDOCS/ cp LICENSE $pkgdocs/
mkfinalpkg mkfinalpkg
} }

100
buildsamples/sample.SMBuild.explained
View file

@ -4,78 +4,77 @@
# users may find this file more familiar and can therefore parse more quickly. # users may find this file more familiar and can therefore parse more quickly.
# Simplified build file logic for slackware and non-slackware users: # Simplified build file logic for slackware and non-slackware users:
# a. Invoke the build file, ./openssh.SMBuild without any arguments # a. Set all necessary options in /etc/bldpkg.conf
# b. Script is invoked in sh/bash # b. Create app directory and download its source
# c. Define APP, VERSION and BUILD variables # c. Copy sample build file sample.SMBuild from /etc
# d. Optionally add and define SM_DISTCC, SM_CCACHE and SM_DEBUG variables # d. Define app, version, build, homepage, download, desc and requires variables in the build file
# e. BUILDVARS variable, unless it is null, is sourced, or /etc/bldpkg.conf file is sourced # e. Optionally add and define sm_distcc, sm_ccache and sm_debug variables
# f. makebuilddirs function removes old package build directory, makes a new one and cd's into $TMP # f. mkandenterbuilddir function removes old package build directory, makes a new one and cd's into $tmp
# g. Old source directory is removed from $TMP and new one is extracted into it # g. Old source directory is removed from $tmp and new one is extracted into it
# h. fixsrcdirpermissions function fixes any permissions inside the new source directory # h. fixbuilddirpermissions function fixes any permissions inside the new source directory
# i. Usual compile options like ./configure --prefix="" ; make ; make install DESTDIR=$PKG # i. Add any commands to extract the source directory if the source directory has a non-standard hierarchy
# are added defined by the user # j. Usual compile options like ./configure --prefix="" ; make ; make install DESTDIR=$pkg follow
# j. Any runit service files, if optionally needed, are added by invoking the preprunitservice # k. Add any runit service files, if optionally needed, using preprunitservice <service name> down
# function # l. mkfinalpkg function prepares the final package directory and places it inside a location defined in $pkgdest in /etc/bldpkg.conf
# k. makefinalpkg function prepares the final package directory and places it inside $PKGDEST
#!/bin/bash #!/bin/bash
APP=openssh app=openssh
# ^ define the application name to be built/compiled and packaged. # ^ define the application name to be built/compiled and packaged.
# **This variable must be defined.** # **This variable must be defined.**
VERSION=8.1 version=8.1
# ^ define the application's version number # ^ define the application's version number
# **This variable must be defined.** # **This variable must be defined.**
BUILD=1sml build=1sml
# ^ define the build tag and count of the package in case changes are being introduced # ^ define the build tag and count of the package in case changes are being introduced
# to this build file while the version is still the same. The count is incremented # to this build file while the version is still the same. The count is incremented
# everytime a change is made to the build file. If the version is different, reset # everytime a change is made to the build file. If the version is different, reset
# this to 1sml for the new version and increment from there on if changes are made again. # this to 1sml for the new version and increment from there on if changes are made again.
# **This variable must be defined.** # **This variable must be defined.**
SM_DISTCC=0 homepage=""
# ^ Add Homepage URL or website of the author of package to this. This variable *must be defined*
download=""
# ^ Add Download URL of the package source ( can be tar.xz or tar.gz or any of the tarballs / zipfiles available ).
# This variable *must be defined*
desc=""
# ^ Add a brief description of what the package is about. This variable *must be defined*.
requires=""
# ^ Add runtime dependencies to this variable, each dependency separated by a space. This variable *must be defined*.
sm_distcc=0
# ^ This variable, when set to 0, will cause the build system to not use distcc # ^ This variable, when set to 0, will cause the build system to not use distcc
# for building this particular package. See also how SM_GLOBALDISTCC variable # for building this particular package. See also how sm_globaldistcc variable
# in bldpkg.conf affects this option. # in bldpkg.conf affects this option.
# This variable is optional. # This variable is optional.
SM_CCACHE=0 sm_ccache=0
# ^ This variable, when set to 0, will cause the build system to not use ccache # ^ This variable, when set to 0, will cause the build system to not use ccache
# for building this particular package. See also how SM_GLOBALCCACHE variable # for building this particular package. See also how sm_globalccache variable
# in bldpkg.conf affects this option. # in bldpkg.conf affects this option.
# This variable is optional. # This variable is optional.
SM_DEBUG=1 sm_debug=1
# ^ This variable, when set to 1, will produce a debug build by preserving any # ^ This variable, when set to 1, will produce a debug build by preserving any
# debug symbols in the binaries and libraries contained in $PKG. # debug symbols in the binaries and libraries contained in $pkg.
# Default is to strip all binaries and libraries. # Default is to strip all binaries and libraries.
# This variable is optional. # This variable is optional.
SM_NOAUTOCONFSITE=1 sm_noautoconfsite=1
# ^ This variable, when set to 1, will disable exporting of the CONFIG_SITE variable. # ^ This variable, when set to 1, will disable exporting of the CONFIG_SITE variable.
# CONFIG_SITE points to a file path defined in bldpkg.conf that holds predefined answers # CONFIG_SITE points to a file path defined in bldpkg.conf that holds predefined answers
# to various configure tests. Use it if a package's configure script returns errors # to various configure tests. Use it if a package's configure script returns errors
# which it normally wouldn't when the cache file was not used. # which it normally wouldn't when the cache file was not used.
# This variable is optional. # This variable is optional.
SM_SKIPCHECKSUM=1 sm_skipchecksum=1
# ^ This variable, when set to 1, will cause the build system to skip checksum verifications. Use it when building # ^ This variable, when set to 1, will cause the build system to skip checksum verifications. Use it when building
# packages that contain files without any extensions, like scripts or any binaries # packages that contain files without any extensions, like scripts or any binaries
HOMEPAGE=""
# ^ Add Homepage URL or website of the author of package to this
DOWNLOAD=""
# ^ Add Download URL of the package source ( can be tar.xz or tar.gz or any of the tarballs /
# zipfiles available
DESC=""
# ^ Add a brief description of what the package is about
REQUIRES=""
# ^ Add runtime dependencies to this variable, each dependency separated by a space
build() { build() {
# ^ Start of the "build" function. This function lists the steps for the order in which to compile # ^ Start of the "build" function. This function lists the steps for the order in which to compile
# a given package. The order basically consists of invoking other functions that are defined # a given package. The order basically consists of invoking other functions that are defined
@ -87,19 +86,19 @@ build() {
mkandenterbuilddir mkandenterbuilddir
# ^ Function defined in and sourced from bldpkg.conf to prepare the package directories. Similar # ^ Function defined in and sourced from bldpkg.conf to prepare the package directories. Similar
# to SlackBuild's rm -rf $TMP/package-$APP ; mkdir $TMP/package-$APP, but in addition to that, # to SlackBuild's rm -rf $tmp/package-$app ; mkdir $tmp/package-$app, but in addition to that,
# it also creates the PKGDOCS directory that may contain a copy of this build file and # it also creates the "pkgdocs" directory that may contain a copy of this build file and
# LICENSEs and READMEs if any, as defined by the user later in the build, and PKGDEST directory, # LICENSEs and READMEs if any, as defined by the user later in the build, and $pkgdest directory,
# where the final package will be put into. When that is done, this function will *cd into $TMP* # where the final package will be put into. When that is done, this function will *cd into $tmp*
# ** This function is necessary for most builds** unless you have a compelling reason to preserve # ** This function is necessary for most builds** unless you have a compelling reason to preserve
# old source directories. # old source directories.
rm -rf $APP-$VERSION rm -rf $app-$version
# ^ remove the old source directory inside *$TMP/$APP.src* # ^ remove the old source directory inside *$TMP/$APP.src*
tar xf $SRCDIR/$APP-$VERSION.tar.?z* tar xf $srcdir/$app-$version.tar.?z*
# ^ Extract the source tarball from $SRCDIR, in effect creating a new source directory inside $TMP. # ^ Extract the source tarball from $SRCDIR, in effect creating a new source directory inside $TMP.
# This source directory is useful when you have to delete further extracted source directories, # This source directory is useful when you have to delete further extracted source directories,
# because this directory is unique, and when using TMPFS, the build system can delete this # because this directory is unique, and when using TMPFS, the build system can delete this
@ -109,8 +108,8 @@ build() {
# of deleting glib-2.99. # of deleting glib-2.99.
cd $APP-$VERSION cd $app-$version
# ^ cd into $TMP/$APP.src/$APP-$VERSION # ^ cd into $tmp/$app.src/$app-$version
fixbuilddirpermissions fixbuilddirpermissions
@ -124,7 +123,7 @@ build() {
--sysconfdir=/etc | --sysconfdir=/etc |
| |
make | make |
make install DESTDIR=$PKG | make install DESTDIR=$pkg |
| |
# OR | # OR |
| <- the usual compile stuff that goes into building the package | <- the usual compile stuff that goes into building the package
@ -134,7 +133,7 @@ build() {
-Ddocs=false | -Ddocs=false |
| |
ninja | ninja |
DESTDIR="$PKG" ninja install ------+ DESTDIR="$pkg" ninja install ------+
preprunitservice <openssh> <down> <finish> preprunitservice <openssh> <down> <finish>
@ -149,6 +148,9 @@ build() {
# when told. The "finish" file should have all the cleanup routines defined. # when told. The "finish" file should have all the cleanup routines defined.
# This function and its arguments are optional # This function and its arguments are optional
cp LICENSE $pkgdocs/
removestaticlibs removestaticlibs
# ^ Function to forcefully discard any static libraries in case explicitly disabling building them doesn't work # ^ Function to forcefully discard any static libraries in case explicitly disabling building them doesn't work
@ -159,8 +161,8 @@ build() {
# a. Copy post-install files like slack-{desc,required} and doinst.sh # a. Copy post-install files like slack-{desc,required} and doinst.sh
# b. Compress and link man pages # b. Compress and link man pages
# c. Determine whether to strip or produce a debug build # c. Determine whether to strip or produce a debug build
# d. Provide a copy of this entire build file insode $PKGDOCS # d. Provide a copy of this entire build file insode $pkgdocs
# e. Generate the final smlinux-compatible package inside $PKGDEST # e. Generate the final smlinux-compatible package inside $pkgdest
# f. Generate a build summary including time when the build started, stopped, whether distcc or ccache # f. Generate a build summary including time when the build started, stopped, whether distcc or ccache
# was used, compressed/uncompressed sizes of the final package if the build completed successfully, # was used, compressed/uncompressed sizes of the final package if the build completed successfully,
# number of CPU threads, distcc options if any, build type (whether it was a debug build or not). # number of CPU threads, distcc options if any, build type (whether it was a debug build or not).