doc: add ABI documentation
[dpdk.git] / mk / rte.sdkexamples.mk
1 #   BSD LICENSE
2 #
3 #   Copyright(c) 2014 6WIND S.A.
4 #
5 #   Redistribution and use in source and binary forms, with or without
6 #   modification, are permitted provided that the following conditions
7 #   are met:
8 #
9 #     * Redistributions of source code must retain the above copyright
10 #       notice, this list of conditions and the following disclaimer.
11 #     * Redistributions in binary form must reproduce the above copyright
12 #       notice, this list of conditions and the following disclaimer in
13 #       the documentation and/or other materials provided with the
14 #       distribution.
15 #     * Neither the name of 6WIND S.A. nor the names of its
16 #       contributors may be used to endorse or promote products derived
17 #       from this software without specific prior written permission.
18 #
19 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31 # examples application are seen as external applications which are
32 # not part of SDK.
33 BUILDING_RTE_SDK :=
34 export BUILDING_RTE_SDK
35
36 # Build directory is given with O=
37 O ?= $(RTE_SDK)/examples
38
39 # Target for which examples should be built.
40 T ?= *
41
42 # list all available configurations
43 EXAMPLES_CONFIGS := $(patsubst $(RTE_SRCDIR)/config/defconfig_%,%,\
44         $(wildcard $(RTE_SRCDIR)/config/defconfig_$(T)))
45 EXAMPLES_TARGETS := $(addsuffix _examples,\
46         $(filter-out %~,$(EXAMPLES_CONFIGS)))
47
48 .PHONY: examples
49 examples: $(EXAMPLES_TARGETS)
50
51 %_examples:
52         @echo ================== Build examples for $*
53         $(Q)if [ ! -d "${RTE_SDK}/${*}" ]; then \
54                 echo "Target ${*} does not exist in ${RTE_SDK}/${*}." ; \
55                 echo -n "Please install DPDK first (make install) or use another " ; \
56                 echo "target argument (T=target)." ; \
57                 false ; \
58         else \
59                 $(MAKE) -C examples O=$(abspath $(O)) RTE_TARGET=$(*); \
60         fi
61
62 EXAMPLES_CLEAN_TARGETS := $(addsuffix _examples_clean,\
63         $(filter-out %~,$(EXAMPLES_CONFIGS)))
64
65 .PHONY: examples_clean
66 examples_clean: $(EXAMPLES_CLEAN_TARGETS)
67
68 %_examples_clean:
69         @echo ================== Clean examples for $*
70         $(Q)if [ ! -d "${RTE_SDK}/${*}" ]; then \
71                 echo "Target ${*} does not exist in ${RTE_SDK}/${*}." ; \
72                 echo -n "Please install DPDK first (make install) or use another " ; \
73                 echo "target argument (T=target)." ; \
74                 false ; \
75         else \
76                 $(MAKE) -C examples O=$(abspath $(O)) RTE_TARGET=$(*) clean; \
77         fi