diff --git a/buildsamples/sample.SMBuild b/buildsamples/sample.SMBuild index 1067b7c..353f083 100755 --- a/buildsamples/sample.SMBuild +++ b/buildsamples/sample.SMBuild @@ -1,16 +1,17 @@ -APP= -VERSION= -BUILD=1sml -HOMEPAGE="" -DOWNLOAD="" -REQUIRES="" +app= +version= +build=1sml +homepage="" +download="" +desc="" +requires="" build() { mkandenterbuilddir - rm -rf $APP-$VERSION + rm -rf $app-$version - tar xf $SRCDIR/$APP-$VERSION.tar.?z* - cd $APP-$VERSION + tar xf $srcdir/$app-$version.tar.?z* + cd $app-$version fixbuilddirpermissions ./configure \ @@ -18,9 +19,9 @@ build() { --sysconfdir=/etc make - make install DESTDIR=$PKG + make install DESTDIR=$pkg - cp LICENSE $PKGDOCS/ + cp LICENSE $pkgdocs/ mkfinalpkg } diff --git a/buildsamples/sample.SMBuild.explained b/buildsamples/sample.SMBuild.explained index cca3bcf..f16a6d4 100755 --- a/buildsamples/sample.SMBuild.explained +++ b/buildsamples/sample.SMBuild.explained @@ -4,78 +4,77 @@ # users may find this file more familiar and can therefore parse more quickly. # Simplified build file logic for slackware and non-slackware users: -# a. Invoke the build file, ./openssh.SMBuild without any arguments -# b. Script is invoked in sh/bash -# c. Define APP, VERSION and BUILD variables -# d. Optionally add and define SM_DISTCC, SM_CCACHE and SM_DEBUG variables -# e. BUILDVARS variable, unless it is null, is sourced, or /etc/bldpkg.conf file is sourced -# f. makebuilddirs 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 -# h. fixsrcdirpermissions function fixes any permissions inside the new source directory -# i. Usual compile options like ./configure --prefix="" ; make ; make install DESTDIR=$PKG -# are added defined by the user -# j. Any runit service files, if optionally needed, are added by invoking the preprunitservice -# function -# k. makefinalpkg function prepares the final package directory and places it inside $PKGDEST +# a. Set all necessary options in /etc/bldpkg.conf +# b. Create app directory and download its source +# c. Copy sample build file sample.SMBuild from /etc +# d. Define app, version, build, homepage, download, desc and requires variables in the build file +# e. Optionally add and define sm_distcc, sm_ccache and sm_debug variables +# 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 +# h. fixbuilddirpermissions function fixes any permissions inside the new source directory +# i. Add any commands to extract the source directory if the source directory has a non-standard hierarchy +# j. Usual compile options like ./configure --prefix="" ; make ; make install DESTDIR=$pkg follow +# k. Add any runit service files, if optionally needed, using preprunitservice down +# l. mkfinalpkg function prepares the final package directory and places it inside a location defined in $pkgdest in /etc/bldpkg.conf #!/bin/bash -APP=openssh +app=openssh # ^ define the application name to be built/compiled and packaged. # **This variable must be defined.** -VERSION=8.1 +version=8.1 # ^ define the application's version number # **This variable must be defined.** -BUILD=1sml +build=1sml # ^ 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 # 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 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 -# 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. # 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 -# 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. # This variable is optional. -SM_DEBUG=1 +sm_debug=1 # ^ 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. # This variable is optional. -SM_NOAUTOCONFSITE=1 +sm_noautoconfsite=1 # ^ 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 # 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. # 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 # 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() { # ^ 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 @@ -87,19 +86,19 @@ build() { mkandenterbuilddir # ^ 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, - # 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, - # where the final package will be put into. When that is done, this function will *cd into $TMP* + # 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 + # 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* # ** This function is necessary for most builds** unless you have a compelling reason to preserve # old source directories. - rm -rf $APP-$VERSION + rm -rf $app-$version # ^ 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. # 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 @@ -109,8 +108,8 @@ build() { # of deleting glib-2.99. - cd $APP-$VERSION - # ^ cd into $TMP/$APP.src/$APP-$VERSION + cd $app-$version + # ^ cd into $tmp/$app.src/$app-$version fixbuilddirpermissions @@ -124,7 +123,7 @@ build() { --sysconfdir=/etc | | make | - make install DESTDIR=$PKG | + make install DESTDIR=$pkg | | # OR | | <- the usual compile stuff that goes into building the package @@ -134,7 +133,7 @@ build() { -Ddocs=false | | ninja | - DESTDIR="$PKG" ninja install ------+ + DESTDIR="$pkg" ninja install ------+ preprunitservice @@ -149,6 +148,9 @@ build() { # when told. The "finish" file should have all the cleanup routines defined. # This function and its arguments are optional + + cp LICENSE $pkgdocs/ + removestaticlibs # ^ 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 # b. Compress and link man pages # c. Determine whether to strip or produce a debug build - # d. Provide a copy of this entire build file insode $PKGDOCS - # e. Generate the final smlinux-compatible package inside $PKGDEST + # d. Provide a copy of this entire build file insode $pkgdocs + # 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 # 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).