doc: add ABI documentation
[dpdk.git] / mk / rte.obj.mk
1 #   BSD LICENSE
2 #
3 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
4 #   All rights reserved.
5 #
6 #   Redistribution and use in source and binary forms, with or without
7 #   modification, are permitted provided that the following conditions
8 #   are met:
9 #
10 #     * Redistributions of source code must retain the above copyright
11 #       notice, this list of conditions and the following disclaimer.
12 #     * Redistributions in binary form must reproduce the above copyright
13 #       notice, this list of conditions and the following disclaimer in
14 #       the documentation and/or other materials provided with the
15 #       distribution.
16 #     * Neither the name of Intel Corporation nor the names of its
17 #       contributors may be used to endorse or promote products derived
18 #       from this software without specific prior written permission.
19 #
20 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 include $(RTE_SDK)/mk/internal/rte.compile-pre.mk
33 include $(RTE_SDK)/mk/internal/rte.install-pre.mk
34 include $(RTE_SDK)/mk/internal/rte.clean-pre.mk
35 include $(RTE_SDK)/mk/internal/rte.build-pre.mk
36 include $(RTE_SDK)/mk/internal/rte.depdirs-pre.mk
37
38 # VPATH contains at least SRCDIR
39 VPATH += $(SRCDIR)
40
41 ifneq ($(OBJ),)
42 _BUILD = $(OBJ)
43 else
44 _BUILD = $(OBJS-y)
45 endif
46 _INSTALL = $(INSTALL-FILES-y) $(SYMLINK-FILES-y)
47 _CLEAN = doclean
48
49 .PHONY: all
50 all: install
51
52 .PHONY: install
53 install: build _postinstall
54
55 _postinstall: build
56
57 .PHONY: build
58 build: _postbuild
59
60 ifneq ($(OBJ),)
61 exe2cmd = $(strip $(call dotfile,$(patsubst %,%.cmd,$(1))))
62
63 O_TO_O = $(LD) -r -o $(OBJ) $(OBJS-y)
64 O_TO_O_STR = $(subst ','\'',$(O_TO_O)) #'# fix syntax highlight
65 O_TO_O_DISP =  $(if $(V),"$(O_TO_O_STR)","  LD $(@)")
66 O_TO_O_CMD = "cmd_$@ = $(O_TO_O_STR)"
67 O_TO_O_DO = @set -e; \
68         echo $(O_TO_O_DISP); \
69         $(O_TO_O) && \
70         echo $(O_TO_O_CMD) > $(call exe2cmd,$(@))
71
72 -include .$(OBJ).cmd
73
74 #
75 # Archive objects in .a file if needed
76 #
77 $(OBJ): $(OBJS-y) FORCE
78         @[ -d $(dir $@) ] || mkdir -p $(dir $@)
79         $(if $(D),\
80                 @echo -n "$< -> $@ " ; \
81                 echo -n "file_missing=$(call boolean,$(file_missing)) " ; \
82                 echo -n "cmdline_changed=$(call boolean,$(call cmdline_changed,$(O_TO_O_STR))) " ; \
83                 echo -n "depfile_missing=$(call boolean,$(depfile_missing)) " ; \
84                 echo "depfile_newer=$(call boolean,$(depfile_newer)) ")
85         $(if $(or \
86                 $(file_missing),\
87                 $(call cmdline_changed,$(O_TO_O_STR)),\
88                 $(depfile_missing),\
89                 $(depfile_newer)),\
90                 $(O_TO_O_DO))
91 endif
92
93 #
94 # Clean all generated files
95 #
96 .PHONY: clean
97 clean: _postclean
98
99 .PHONY: doclean
100 doclean:
101         @rm -rf $(OBJ) $(OBJS-all) $(DEPS-all) $(DEPSTMP-all) \
102           $(CMDS-all) $(INSTALL-FILES-all)
103         @rm -f $(_BUILD_TARGETS) $(_INSTALL_TARGETS) $(_CLEAN_TARGETS)
104
105 include $(RTE_SDK)/mk/internal/rte.compile-post.mk
106 include $(RTE_SDK)/mk/internal/rte.install-post.mk
107 include $(RTE_SDK)/mk/internal/rte.clean-post.mk
108 include $(RTE_SDK)/mk/internal/rte.build-post.mk
109 include $(RTE_SDK)/mk/internal/rte.depdirs-post.mk
110
111 .PHONY: FORCE
112 FORCE: