core/tasks/apicheck.mk

   1 # Copyright (C) 2008 The Android Open Source Project
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 #
  16 # Rules for running apicheck to confirm that you haven't broken
  17 # api compatibility or added apis illegally.
  18 #
  19
  20 ifneq ($(BUILD_TINY_ANDROID), true)
  21
  22 .PHONY: checkapi
  23
  24 # eval this to define a rule that runs apicheck.
  25 #
  26 # Args:
  27 #    $(1)  target
  28 #    $(2)  stable api xml file
  29 #    $(3)  api xml file to be tested
  30 #    $(4)  arguments for apicheck
  31 #    $(5)  command to run if apicheck failed
  32 define check-api
  33 $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/$(strip $(1))-timestamp: $(2) $(3) $(APICHECK)
  34         @echo "Checking API:" $(1)
  35         $(hide) ( $(APICHECK) $(4) $(2) $(3) || ( $(5) ; exit 38 ) )
  36         $(hide) mkdir -p $$(dir $$@)
  37         $(hide) touch $$@
  38 checkapi: $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/$(strip $(1))-timestamp
  39 endef
  40
  41 # Run the checkapi rules by default.
  42 droidcore: checkapi
  43
  44 # INTERNAL_PLATFORM_API_FILE is the one build by droiddoc.
  45
  46 # Check that the API we're building hasn't broken the last-released
  47 # SDK version.
  48 $(eval $(call check-api, \
  49         checkapi-last, \
  50         $(SRC_API_DIR)/$(lastword $(TARGET_AVAILABLE_SDK_VERSIONS)).xml, \
  51         $(INTERNAL_PLATFORM_API_FILE), \
  52         -hide 2 -hide 3 -hide 4 -hide 5 -hide 6 -hide 24 \
  53         -error 7 -error 8 -error 9 -error 10 -error 11 -error 12 -error 13 -error 14 -error 15 \
  54         -error 16 -error 17 -error 18 , \
  55         cat $(BUILD_SYSTEM)/apicheck_msg_last.txt \
  56         ))
  57
  58 # Check that the API we're building hasn't changed from the not-yet-released
  59 # SDK version.
  60 $(eval $(call check-api, \
  61         checkapi-current, \
  62         $(SRC_API_DIR)/current.xml, \
  63         $(INTERNAL_PLATFORM_API_FILE), \
  64         -error 2 -error 3 -error 4 -error 5 -error 6 \
  65         -error 7 -error 8 -error 9 -error 10 -error 11 -error 12 -error 13 -error 14 -error 15 \
  66         -error 16 -error 17 -error 18 -error 19 -error 20 -error 21 -error 23 -error 24 , \
  67         cat $(BUILD_SYSTEM)/apicheck_msg_current.txt \
  68         ))
  69
  70 .PHONY: update-api
  71 update-api: $(INTERNAL_PLATFORM_API_FILE) | $(ACP)
  72         @echo Copying current.xml
  73         $(hide) $(ACP) $(INTERNAL_PLATFORM_API_FILE) $(SRC_API_DIR)/current.xml
  74
  75 endif