acl: new sample l3fwd-acl
[dpdk.git] / mk / rte.sdkdoc.mk
index f44a6b7..8861b05 100644 (file)
@@ -1,12 +1,13 @@
 #   BSD LICENSE
-# 
+#
 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+#   Copyright(c) 2013 6WIND S.A.
 #   All rights reserved.
-# 
+#
 #   Redistribution and use in source and binary forms, with or without
 #   modification, are permitted provided that the following conditions
 #   are met:
-# 
+#
 #     * Redistributions of source code must retain the above copyright
 #       notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above copyright
@@ -16,7 +17,7 @@
 #     * Neither the name of Intel Corporation nor the names of its
 #       contributors may be used to endorse or promote products derived
 #       from this software without specific prior written permission.
-# 
+#
 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
@@ -35,8 +36,33 @@ $(error "Cannot use T= with doc target")
 endif
 endif
 
-.PHONY: doc
-doc:
+.PHONY: help
+help:
+       @cat $(RTE_SDK)/doc/build-sdk-quick.txt
+       @$(MAKE) -rR showconfigs | sed 's,^,\t\t\t\t,'
 
-.PHONY: doc-clean
-doc-clean:
+.PHONY: all
+all: htmlapi
+
+.PHONY: clean
+clean: htmlapi-clean
+
+.PHONY: htmlapi
+htmlapi: htmlapi-clean
+       @echo 'doxygen for API...'
+       $(Q)mkdir -p $(RTE_OUTPUT)/doc/html
+       $(Q)(cat $(RTE_SDK)/doc/doxy-api.conf         && \
+           printf 'PROJECT_NUMBER = '                && \
+                             $(MAKE) -rR showversion && \
+           echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \
+           echo HTML_OUTPUT      = html/api          && \
+           echo GENERATE_HTML    = YES               && \
+           echo GENERATE_LATEX   = NO                && \
+           echo GENERATE_MAN     = NO                )| \
+           doxygen -
+       $(Q)$(RTE_SDK)/doc/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css
+
+.PHONY: htmlapi-clean
+htmlapi-clean:
+       $(Q)rm -f $O/doc/html/api/*
+       $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true