documentation: package.mk #2659

InuSasha · 2018-04-21T12:17:00Z

Since the last changes on the build system, we need an update to our documentation.
I prefer, to place it in github instead of wiki, because it is easier to find for developers (as special new developers)
After finishing/merging this, we should link the wiki to this location.

Actual it is"Work in progress"
Open Thinks, which has to be done first:

description for PKG_NEEDS_UNPACK
functions
spelling check
2 package.mk templates (for non-addon and addon)
incl. how to add a new package
mega-squash :) (i had to look, how github parse the markdown)

I copied most from wiki and the readme in packages/addons

awiouy · 2018-04-21T13:41:14Z

PKG_LONGDESC and PKG_SHORTDESC are only used for addons, to populate addon.xml file.
However, all packages must have PKG_LONGDESC, for documentation.

In summary:

addons must have both PKG_LONGDESC and PKG_SHORTDESC
other packages must have PKG_LONGDESC

InuSasha · 2018-04-21T13:45:20Z

so PKG_SHORTDESC is only required for addons?

edit: push a change for that (required: no, yes for addons)

InuSasha · 2018-04-21T14:50:06Z

I added part "Add a new package to the Image"
and two templates for the package.mk.
(The package.mk.addon_template replaces the README.md from packages/addons.
Before one is asking, we have two addon location under packages/, now: addons and mediacenter/kodi-binary-addons)

Three variables needs a description (which i can not fill):

~~PKG_DISCLAIMER~~
~~PKG_NEED_UNPACK~~
~~PKG_ADDON_IS_STANDALONE~~

Now, i put down my pencil and wait for responses.

InuSasha · 2018-05-25T21:37:10Z

PKG_DISCLAIMER and PKG_ADDON_IS_STANDALONE described.
all squashed

chewitt · 2018-05-26T02:46:06Z

packages/packages.mk.addon_template

+################################################################################
+
+PKG_NAME="[package name]"
+PKG_VERSION="[package upstream version]"


"[package version identifier or unique githash]"

chewitt · 2018-05-26T02:48:59Z

packages/packages.mk.addon_template

+PKG_SITE="[url to the upstream project, e.g. http://exmaple.com/libexample"
+PKG_URL="[download url, e.g. https://github.com/example/libexample/archive/$PKG_VERSION.tar.gz]"
+# PKG_MAINTAINER="John Doe (email)" # if you want to be know as maintainer for a addon
+PKG_DEPENDS_TARGET="[needed packages for build, e.g. toolchain zlib openssl]"


"[build system dependencies, e.g. toolchain zlib openssl]"

chewitt · 2018-05-26T02:50:06Z

packages/packages.mk.addon_template

+# PKG_MAINTAINER="John Doe (email)" # if you want to be know as maintainer for a addon
+PKG_DEPENDS_TARGET="[needed packages for build, e.g. toolchain zlib openssl]"
+PKG_SECTION="[location under packages, e.g. database]"
+PKG_SHORTDESC="[short description (mostly find at the upstrem project), e.g. libexample: library to calculate examples]"


"[short description of the package, e.g. libexample: library to calculate examples]"

chewitt · 2018-05-26T02:52:56Z

packages/packages.mk.addon_template

+PKG_DEPENDS_TARGET="[needed packages for build, e.g. toolchain zlib openssl]"
+PKG_SECTION="[location under packages, e.g. database]"
+PKG_SHORTDESC="[short description (mostly find at the upstrem project), e.g. libexample: library to calculate examples]"
+PKG_LONGDESC="[long description (mostly find at the upstrem project), e.g. libexample: this project is created for case x and y, to do it, in a best way...]"


"[long description of the package, often taken from the package/project website, e.g. libexample: this project is created to calculate examples for x and y, with maximum efficiency and fewer errors]"

chewitt · 2018-05-26T02:57:13Z

packages/packages.mk.addon_template

+PKG_LICENSE="[license of the upstream project]"
+PKG_SITE="[url to the upstream project, e.g. http://exmaple.com/libexample"
+PKG_URL="[download url, e.g. https://github.com/example/libexample/archive/$PKG_VERSION.tar.gz]"
+# PKG_MAINTAINER="John Doe (email)" # if you want to be know as maintainer for a addon


"John Doe" # Full name or forum/GitHub nickname, if you want to be identified as the addon maintainer

^ we should stop using emails, it results in text-length issues in the Kodi GUI and it's just a bad idea to have emails collected these days (privacy, GDPR, etc.)

chewitt · 2018-05-26T03:00:10Z

packages/readme.md

+
+## Variables
+All avialible variable, to control the build behavoir of your package.
+Please use these in the order, listed here.


To control the build behaviour of your package, use variables in the top-down order listed here.

chewitt · 2018-05-26T03:02:05Z

packages/readme.md

+| PKG_VERSION | -       | yes | Version of the packaged software application |
+| PKG_SHA256  | -       | yes | SHA256 hashsum of the application download file |
+| PKG_ARCH    | any     | no  | Architectures for which the package builds. `any` or a space separated list of `aarch64`, `arm` or `x86_64` |
+| PKG_LICENSE | -       | yes | License of the software application. [Reference](https://github.com/LibreELEC/LibreELEC.tv/tree/master/licenses) |


It needs to be agreed in the team, but I think we should use SPDX notation for this

i leave it for, now. we can change this later. (But i am pro for SPDX)

chewitt · 2018-05-26T03:03:49Z

packages/readme.md

+| PKG_MAINTAINER | -    | no  | Your name |
+| PKG_DEPENDS_BOOTSTRAP<br>PKG_DEPENDS_HOST   PKG_DEPENDS_INIT   PKG_DEPENDS_TARGET | - | no | A space separated list of name of packages required to build the software application |
+| PKG_SECTION | -       | no  | virtual if the package only defines dependencies |
+| PKG_SHORTDESC | -     | no<br>yes&nbsp;for&nbsp;addons | Short description of the application software used in various parts of Kodi |


"Short description of the software package"

chewitt · 2018-05-26T03:04:54Z

packages/readme.md

+| PKG_DEPENDS_BOOTSTRAP<br>PKG_DEPENDS_HOST   PKG_DEPENDS_INIT   PKG_DEPENDS_TARGET | - | no | A space separated list of name of packages required to build the software application |
+| PKG_SECTION | -       | no  | virtual if the package only defines dependencies |
+| PKG_SHORTDESC | -     | no<br>yes&nbsp;for&nbsp;addons | Short description of the application software used in various parts of Kodi |
+| PKG_LONGDESC | -      | yes | Long description of the application software used in various parts of Kodi |


"Long description of the package including purpose or function within LibreELEC or Kodi"

chewitt · 2018-05-26T03:11:05Z

packages/readme.md

+#### Universal Build Option
+| Variable    | Default | Required |Description |
+|-------------|---------|----------|------------|
+| PKG_SOURCE_DIR | -    | no  | Name of the folder to which the source of the software application unpacks. Should only be specified if the source of the software application unpacks to a folder whose name does not start with `$PKG_NAME` |


Force the folder name that application sources are unpacked to. Used when sources do not automatically unpack to a folder with the PKG_NAME-PKG_VERSION naming convention.

chewitt · 2018-05-26T03:13:40Z

packages/readme.md

+| Variable    | Default | Required |Description |
+|-------------|---------|----------|------------|
+| PKG_SOURCE_DIR | -    | no  | Name of the folder to which the source of the software application unpacks. Should only be specified if the source of the software application unpacks to a folder whose name does not start with `$PKG_NAME` |
+| PKG_SOURCE_NAME | -   | no  | Name of the file of the source of the software application. Should only be specified if the source of the software application is not the basename of PKG_URL |


Force the filename of the application sources. Used when the filename is not the basename of PKG_URL

chewitt · 2018-05-26T03:19:11Z

packages/readme.md

+|-------------|---------|----------|------------|
+| PKG_SOURCE_DIR | -    | no  | Name of the folder to which the source of the software application unpacks. Should only be specified if the source of the software application unpacks to a folder whose name does not start with `$PKG_NAME` |
+| PKG_SOURCE_NAME | -   | no  | Name of the file of the source of the software application. Should only be specified if the source of the software application is not the basename of PKG_URL |
+| PKG_PATCH_DIRS | -    | no  | Change the path for pachtes, to apply to source. Normally the path `./patches` is used. Is this variable is set, the normal path will extended with the value of this variable as a subdirectory: `./patches/${PKG_PATCH_DIRS}` |


Patches in ./patches are automatically applied after package unpack. Use this option to include patches from an additional folder, e.g. ./patches/$PKG_PATCH_DIRS

chewitt · 2018-05-26T03:23:31Z

packages/readme.md

+| PKG_SOURCE_NAME | -   | no  | Name of the file of the source of the software application. Should only be specified if the source of the software application is not the basename of PKG_URL |
+| PKG_PATCH_DIRS | -    | no  | Change the path for pachtes, to apply to source. Normally the path `./patches` is used. Is this variable is set, the normal path will extended with the value of this variable as a subdirectory: `./patches/${PKG_PATCH_DIRS}` |
+| PKG_NEED_UNPACK | -   | no  | ??? can anyone explane, i have no idea. |
+| PKG_TOOLCHAIN | auto  | no  | Control which of the build toolchains is used. For detailed information, see the [Reference](#toolchain-options). |


Control which build toolchain is used. For detailed information, see [reference]

chewitt · 2018-05-26T03:26:59Z

packages/readme.md

+| PKG_NEED_UNPACK | -   | no  | ??? can anyone explane, i have no idea. |
+| PKG_TOOLCHAIN | auto  | no  | Control which of the build toolchains is used. For detailed information, see the [Reference](#toolchain-options). |
+| PKG_BUILD_FLAGS | -   | no  | A Space seperated list of flags, which control often used build modification. Flags can be enabled or disables with a prefixed `+`/`-`. For detailed information, see the [Reference](#build_flags-options). |
+| PKG_PYTHON_VERSION | python2.7 | no | Defines the Python version, which should use. |


Define the Python version to be used

chewitt · 2018-05-26T03:27:50Z

packages/readme.md

+| PKG_TOOLCHAIN | auto  | no  | Control which of the build toolchains is used. For detailed information, see the [Reference](#toolchain-options). |
+| PKG_BUILD_FLAGS | -   | no  | A Space seperated list of flags, which control often used build modification. Flags can be enabled or disables with a prefixed `+`/`-`. For detailed information, see the [Reference](#build_flags-options). |
+| PKG_PYTHON_VERSION | python2.7 | no | Defines the Python version, which should use. |
+| PKG_IS_KERNEL_PKG | - | no  | Set it to `yes`, for packages which include linux kernel modules |


Set to yes for packages that include Linux kernel modules

chewitt · 2018-05-26T03:36:48Z

packages/readme.md

+
+#### Addons
+These options only needed, when the package is build as an addon.
+"Required" column is focus addon packages, only. When the package is no addon, none of these options is required.


Additional options used when the package builds an addon.

^ only this line is needed

MilhouseVH · 2018-05-26T03:50:09Z

packages/readme.md

+| PKG_PATCH_DIRS | -    | no  | Change the path for pachtes, to apply to source. Normally the path `./patches` is used. Is this variable is set, the normal path will extended with the value of this variable as a subdirectory: `./patches/${PKG_PATCH_DIRS}` |
+| PKG_NEED_UNPACK | -   | no  | ??? can anyone explane, i have no idea. |
+| PKG_TOOLCHAIN | auto  | no  | Control which of the build toolchains is used. For detailed information, see the [Reference](#toolchain-options). |
+| PKG_BUILD_FLAGS | -   | no  | A Space seperated list of flags, which control often used build modification. Flags can be enabled or disables with a prefixed `+`/`-`. For detailed information, see the [Reference](#build_flags-options). |


s/seperated/separated (also repeated in line 117)
", which control often used build modification." - maybe instead: "with which to fine-tune the build process."?
s/disables/disabled - "Flags can be enabled or disabled with a + or - prefix." may also read a little more easily.

chewitt · 2018-05-26T03:55:31Z

packages/readme.md

+| PKG_SOURCE_DIR | -    | no  | Name of the folder to which the source of the software application unpacks. Should only be specified if the source of the software application unpacks to a folder whose name does not start with `$PKG_NAME` |
+| PKG_SOURCE_NAME | -   | no  | Name of the file of the source of the software application. Should only be specified if the source of the software application is not the basename of PKG_URL |
+| PKG_PATCH_DIRS | -    | no  | Change the path for pachtes, to apply to source. Normally the path `./patches` is used. Is this variable is set, the normal path will extended with the value of this variable as a subdirectory: `./patches/${PKG_PATCH_DIRS}` |
+| PKG_NEED_UNPACK | -   | no  | ??? can anyone explane, i have no idea. |


Space separated list of files or folders to include in package stamp calculation. If the stamp is invalidated through changes to package files or dependent files/folders the package is cleaned and rebuilt. e.g. PKG_NEED_UNPACK="$(get_pkg_directory linux)" will trigger clean/rebuild of a Linux kernel driver package when a change to the linux kernel package is detected.

chewitt · 2018-05-26T03:56:39Z

packages/readme.md

+| Variable    | Default | Required |Description |
+|-------------|---------|----------|------------|
+| PKG_REV     | -       | yes      | The revision number of the addon. Increase on every version. Currently starts at `100`. Please place this variable under `PKG_VERSION` |
+| PKG_IS_ADDON | no     | yes      | Have to set to `yes` |


Must be set to yes

chewitt · 2018-05-26T03:59:19Z

packages/readme.md

+
+| Variable    | Default | Required |Description |
+|-------------|---------|----------|------------|
+| PKG_REV     | -       | yes      | The revision number of the addon. Increase on every version. Currently starts at `100`. Please place this variable under `PKG_VERSION` |


The revision number of the addon (starts at 100). Must be placed after PKG_VERSION. Must be incremented for each new version else Kodi clients will not detect version change and download the updated addon.

InuSasha · 2018-05-26T08:43:15Z

merged your fixes. many thanks @chewitt

jernejsk · 2018-05-26T10:01:22Z

packages/packages.mk.addon_template

+PKG_SHA256="[sha256 hash of the source file, downloaded from PKG_URL]"
+PKG_ARCH="any"
+PKG_LICENSE="[license of the upstream project]"
+PKG_SITE="[url to the upstream project, e.g. http://exmaple.com/libexample"


exmaple.com is misspelled

InuSasha · 2018-05-28T08:18:03Z

a "good to go" from me.

awiouy added WORK IN PROGRESS HELP WANTED labels Apr 21, 2018

InuSasha force-pushed the doc/package branch from ff70dfe to 4795da6 Compare April 21, 2018 14:06

documentation: package.mk

f177baf

InuSasha force-pushed the doc/package branch from 3877c0a to f177baf Compare May 25, 2018 21:34

chewitt reviewed May 26, 2018

View reviewed changes

MilhouseVH reviewed May 26, 2018

View reviewed changes

chewitt reviewed May 26, 2018

View reviewed changes

documentation: spelling fixes from @chewitt & @MilhouseVH

d152261

documentation: more spelling fixes

9c868de

jernejsk reviewed May 26, 2018

View reviewed changes

documentation: typo

e859aa0

documentation: remove unneeded comment

0f61380

CvH added DOCUMENTATION BUILDSYSTEM and removed HELP WANTED WORK IN PROGRESS labels May 28, 2018

CvH approved these changes May 28, 2018

View reviewed changes

CvH merged commit 0214c6a into LibreELEC:master May 28, 2018

InuSasha deleted the doc/package branch May 29, 2018 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

documentation: package.mk #2659

documentation: package.mk #2659

InuSasha commented Apr 21, 2018 •

edited

Loading

awiouy commented Apr 21, 2018

InuSasha commented Apr 21, 2018 •

edited

Loading

InuSasha commented Apr 21, 2018 •

edited

Loading

InuSasha commented May 25, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

InuSasha May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018 •

edited

Loading

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

MilhouseVH May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

chewitt May 26, 2018

InuSasha commented May 26, 2018

jernejsk May 26, 2018

InuSasha commented May 28, 2018

documentation: package.mk #2659

documentation: package.mk #2659

Conversation

InuSasha commented Apr 21, 2018 • edited Loading

awiouy commented Apr 21, 2018

InuSasha commented Apr 21, 2018 • edited Loading

InuSasha commented Apr 21, 2018 • edited Loading

InuSasha commented May 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chewitt May 26, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

InuSasha commented May 26, 2018

Choose a reason for hiding this comment

InuSasha commented May 28, 2018

InuSasha commented Apr 21, 2018 •

edited

Loading

InuSasha commented Apr 21, 2018 •

edited

Loading

InuSasha commented Apr 21, 2018 •

edited

Loading

chewitt May 26, 2018 •

edited

Loading