Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 2.66 KB

version-markers.md

File metadata and controls

70 lines (51 loc) · 2.66 KB
Raw

VERSION markers

NOTE: This section is obsolete! It is here only for historical purposes.

VERSION markers were introduced in kiss version 5.5.0 and removed in version 6.1.1. This represents a period of 1 year and 8 months. If you encounter packages made during this period, chances are that they could use VERSION markers, and you must fix the sources file.

Introduction

VERSION markers were added in July of 2021.

The commit describing them is as folllows:

commit d296b90b75d02ee81ec9a5902f107144f6dda3b8
Author: Dylan Araps <[email protected]>
Date:   Wed Jul 14 17:08:58 2021 +0300

    kiss: support variables in sources files.

    This adds support for replacement of simple markers with
    corresponding values. To handle cases where a replacement
    is not 1:1, various transformations are made available.

    - VERSION : The full version string (first field in version file).
    - MAJOR   : First component separated by '.'.
    - MINOR   : Second component separated by '.'.
    - PATCH   : Third component separated by '.'.
    - IDENT   : All remaining components separated by '.+-'.
    - PKG     : The name of the current package.

    NOTE: This may be reverted. Depends on how good the benefits
    are. Will do an evaluation of the repositories.

However, this was later amended with some extra variables and some renamed variables, due to conflicts with upstream package sources.

Final Variation

The final variation of the VERSION markers is as follows:

variable replacement
VERSION Full version string
MAJOR First component separated by '.'
MINOR Second component separated by '.'
PATCH Third component separated by '.'
IDENT All remaining components separated by '.+-'
PACKAGE The name of the current package
\VERSION The string 'VERSION'
\MAJOR The string 'MAJOR'
\MINOR The string 'MINOR'
\PATCH The string 'PATCH'
\PACKAGE The string 'PACKAGE'

Example Usage

For example, if you wanted to use these variables

Removal

VERSION markers were removed in March of 2023. This was after a lengthy discussion as to their usefulness, which occurred primary in this thread. The primary reason for their removal was due to the complications that it brought to the package format, and making source files more difficult to parse.