version_defaults.mk revision 9c5e7e24b8292f4b46cdc5e4e6c8d69c9df82c01
1#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8#      http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
17#
18# Handle various build version information.
19#
20# Guarantees that the following are defined:
21#     PLATFORM_VERSION
22#     PLATFORM_SDK_VERSION
23#     PLATFORM_VERSION_CODENAME
24#     DEFAULT_APP_TARGET_SDK
25#     BUILD_ID
26#     BUILD_NUMBER
27#     BUILD_DATETIME
28#     PLATFORM_SECURITY_PATCH
29#
30
31# Look for an optional file containing overrides of the defaults,
32# but don't cry if we don't find it.  We could just use -include, but
33# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set
34# if the file exists.
35#
36INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk)
37ifdef INTERNAL_BUILD_ID_MAKEFILE
38  include $(INTERNAL_BUILD_ID_MAKEFILE)
39endif
40
41DEFAULT_PLATFORM_VERSION := OPM1
42MIN_PLATFORM_VERSION := OPM1
43MAX_PLATFORM_VERSION := OPM1
44
45ALLOWED_VERSIONS := $(call allowed-platform-versions,\
46  $(MIN_PLATFORM_VERSION),\
47  $(MAX_PLATFORM_VERSION),\
48  $(DEFAULT_PLATFORM_VERSION))
49
50ifndef TARGET_PLATFORM_VERSION
51  TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION)
52endif
53
54ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION)))
55  $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of)
56  $(error $(ALLOWED_VERSIONS))
57endif
58
59# Default versions for each TARGET_PLATFORM_VERSION
60# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional
61# on this
62
63# This is the canonical definition of the platform version,
64# which is the version that we reveal to the end user.
65# Update this value when the platform version changes (rather
66# than overriding it somewhere else).  Can be an arbitrary string.
67
68# When you add a new PLATFORM_VERSION which will result in a new
69# PLATFORM_SDK_VERSION please ensure you add a corresponding isAtLeast*
70# method in the following java file:
71# frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
72
73# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION
74# please add that PLATFORM_VERSION to the following text file:
75# cts/tests/tests/os/assets/platform_versions.txt
76PLATFORM_VERSION.OPM1 := OMR1
77
78# These are the current development codenames, if the build is not a final
79# release build.  If this is a final release build, it is simply "REL".
80PLATFORM_VERSION_CODENAME.OPM1 := OMR1
81
82ifndef PLATFORM_VERSION
83  PLATFORM_VERSION := $(PLATFORM_VERSION.$(TARGET_PLATFORM_VERSION))
84  ifndef PLATFORM_VERSION
85    # PLATFORM_VERSION falls back to TARGET_PLATFORM_VERSION
86    PLATFORM_VERSION := $(TARGET_PLATFORM_VERSION)
87  endif
88endif
89
90ifndef PLATFORM_SDK_VERSION
91  # This is the canonical definition of the SDK version, which defines
92  # the set of APIs and functionality available in the platform.  It
93  # is a single integer that increases monotonically as updates to
94  # the SDK are released.  It should only be incremented when the APIs for
95  # the new release are frozen (so that developers don't write apps against
96  # intermediate builds).  During development, this number remains at the
97  # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds
98  # the code-name of the new development work.
99
100  # When you change PLATFORM_SDK_VERSION please ensure you also update the
101  # corresponding methods for isAtLeast* in the following java file:
102  # frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
103
104  # When you increment the PLATFORM_SDK_VERSION please ensure you also
105  # clear out the following text file of all older PLATFORM_VERSION's:
106  # cts/tests/tests/os/assets/platform_versions.txt
107  PLATFORM_SDK_VERSION := 26
108endif
109
110ifndef PLATFORM_JACK_MIN_SDK_VERSION
111  # This is definition of the min SDK version given to Jack for the current
112  # platform. For released version it should be the same as
113  # PLATFORM_SDK_VERSION. During development, this number may be incremented
114  # before PLATFORM_SDK_VERSION if the platform starts to add new java
115  # language supports.
116  PLATFORM_JACK_MIN_SDK_VERSION := o-b1
117endif
118
119ifndef PLATFORM_VERSION_CODENAME
120  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
121  ifndef PLATFORM_VERSION_CODENAME
122    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
123    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
124  endif
125
126  # This is all of the development codenames that are active.  Should be either
127  # the same as PLATFORM_VERSION_CODENAME or a comma-separated list of additional
128  # codenames after PLATFORM_VERSION_CODENAME.
129  PLATFORM_VERSION_ALL_CODENAMES :=
130
131  # Build a list of all possible code names. Avoid duplicates, and stop when we
132  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
133  # that is not included in our build.
134  _versions_in_target := \
135    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
136  $(foreach version,$(_versions_in_target),\
137    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
138    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
139      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
140
141  # And convert from space separated to comma separated.
142  PLATFORM_VERSION_ALL_CODENAMES := \
143    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
144
145endif
146
147ifeq (REL,$(PLATFORM_VERSION_CODENAME))
148  PLATFORM_PREVIEW_SDK_VERSION := 0
149else
150  ifndef PLATFORM_PREVIEW_SDK_VERSION
151    # This is the definition of a preview SDK version over and above the current
152    # platform SDK version. Unlike the platform SDK version, a higher value
153    # for preview SDK version does NOT mean that all prior preview APIs are
154    # included. Packages reading this value to determine compatibility with
155    # known APIs should check that this value is precisely equal to the preview
156    # SDK version the package was built for, otherwise it should fall back to
157    # assuming the device can only support APIs as of the previous official
158    # public release.
159    # This value will always be 0 for release builds.
160    PLATFORM_PREVIEW_SDK_VERSION := 1
161  endif
162endif
163
164ifndef DEFAULT_APP_TARGET_SDK
165  # This is the default minSdkVersion and targetSdkVersion to use for
166  # all .apks created by the build system.  It can be overridden by explicitly
167  # setting these in the .apk's AndroidManifest.xml.  It is either the code
168  # name of the development build or, if this is a release build, the official
169  # SDK version of this release.
170  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
171    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
172  else
173    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
174  endif
175endif
176
177ifndef PLATFORM_SECURITY_PATCH
178    #  Used to indicate the security patch that has been applied to the device.
179    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
180    #  It must be of the form "YYYY-MM-DD" on production devices.
181    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
182    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
183      PLATFORM_SECURITY_PATCH := 2017-09-05
184endif
185
186ifndef PLATFORM_BASE_OS
187  # Used to indicate the base os applied to the device.
188  # Can be an arbitrary string, but must be a single word.
189  #
190  # If there is no $PLATFORM_BASE_OS set, keep it empty.
191  PLATFORM_BASE_OS :=
192endif
193
194ifndef BUILD_ID
195  # Used to signify special builds.  E.g., branches and/or releases,
196  # like "M5-RC7".  Can be an arbitrary string, but must be a single
197  # word and a valid file name.
198  #
199  # If there is no BUILD_ID set, make it obvious.
200  BUILD_ID := UNKNOWN
201endif
202
203ifndef BUILD_DATETIME
204  # Used to reproduce builds by setting the same time. Must be the number
205  # of seconds since the Epoch.
206  BUILD_DATETIME := $(shell date +%s)
207endif
208
209ifneq (,$(findstring Darwin,$(UNAME)))
210DATE := date -r $(BUILD_DATETIME)
211else
212DATE := date -d @$(BUILD_DATETIME)
213endif
214
215ifndef BUILD_NUMBER
216  # BUILD_NUMBER should be set to the source control value that
217  # represents the current state of the source code.  E.g., a
218  # perforce changelist number or a git hash.  Can be an arbitrary string
219  # (to allow for source control that uses something other than numbers),
220  # but must be a single word and a valid file name.
221  #
222  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
223  # from this date/time" value.  Make it start with a non-digit so that
224  # anyone trying to parse it as an integer will probably get "0".
225  BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
226endif
227