[PATCH 0/2] version in doxygen

[PATCH 0/2] version in doxygen

[Thomas Monjalon]

These 2 patches allow to print the DPDK version in doxygen header.
-- 
Thomas

---

  mk: add rule to print version number
  mk: insert version number in doxygen config

 mk/rte.sdkconfig.mk |    6 ++++++
 mk/rte.sdkdoc.mk    |    2 ++
 mk/rte.sdkroot.mk   |    4 ++--
 3 files changed, 10 insertions(+), 2 deletions(-)

-- 
1.7.10.4

[PATCH 1/2] mk: add rule to print version number

[Thomas Monjalon]

The version string is extracted from rte_version.h.
RTE_VER_* macros are concatenated and separators " . . r " are inserted.

Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
---
 mk/rte.sdkconfig.mk |    6 ++++++
 mk/rte.sdkroot.mk   |    4 ++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/mk/rte.sdkconfig.mk b/mk/rte.sdkconfig.mk
index 2c071a2..6eb389c 100644
--- a/mk/rte.sdkconfig.mk
+++ b/mk/rte.sdkconfig.mk
@@ -31,6 +31,12 @@
 # 
 #  version: DPDK.L.1.2.3-3
 
+.PHONY: showversion
+showversion:
+	@sed -rn 's,^#define RTE_VER_[A-Z_]*[[:space:]]+([0-9]+).*,\1,p' \
+		$(RTE_SRCDIR)/lib/librte_eal/common/include/rte_version.h | \
+		tr '\n' '.' | sed -r 's,\.([0-9]+)\.$$,r\1\n,'
+
 INSTALL_CONFIGS := $(filter-out %~,\
 	$(patsubst $(RTE_SRCDIR)/config/defconfig_%,%,\
 	$(wildcard $(RTE_SRCDIR)/config/defconfig_*)))
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index 905b678..b5126c0 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -87,8 +87,8 @@ export ROOTDIRS-y ROOTDIRS- ROOTDIRS-n
 .PHONY: default
 default: all
 
-.PHONY: config showconfigs
-config showconfigs:
+.PHONY: config showconfigs showversion
+config showconfigs showversion:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkconfig.mk $@
 
 .PHONY: test fast_test ring_test mempool_test
-- 
1.7.10.4

[PATCH 2/2] mk: insert version number in doxygen config

[Thomas Monjalon]

The parameter PROJECT_NUMBER is used in the HTML header
via the template variable $projectnumber.

Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
---
 mk/rte.sdkdoc.mk |    2 ++
 1 file changed, 2 insertions(+)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 96eec69..d0cda7a 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -54,6 +54,8 @@ 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               && \
-- 
1.7.10.4

Re: [PATCH 2/2] mk: insert version number in doxygen config

[Vincent JARDIN]

it is just look n feel, just push it.

Acked-by: vincent.jardin-pdR9zngts4EAvxtiuMwx3w@public.gmane.org

On 19/07/2013 16:19, Thomas Monjalon wrote:
> The parameter PROJECT_NUMBER is used in the HTML header
> via the template variable $projectnumber.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
> ---
>   mk/rte.sdkdoc.mk |    2 ++
>   1 file changed, 2 insertions(+)
>
> diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
> index 96eec69..d0cda7a 100644
> --- a/mk/rte.sdkdoc.mk
> +++ b/mk/rte.sdkdoc.mk
> @@ -54,6 +54,8 @@ 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               && \
>

Re: [PATCH 1/2] mk: add rule to print version number

[Vincent JARDIN]

it is just look n feel, just push it.

Acked-by: vincent.jardin-pdR9zngts4EAvxtiuMwx3w@public.gmane.org

On 19/07/2013 16:19, Thomas Monjalon wrote:
> The version string is extracted from rte_version.h.
> RTE_VER_* macros are concatenated and separators " . . r " are inserted.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
> ---
>   mk/rte.sdkconfig.mk |    6 ++++++
>   mk/rte.sdkroot.mk   |    4 ++--
>   2 files changed, 8 insertions(+), 2 deletions(-)
>
> diff --git a/mk/rte.sdkconfig.mk b/mk/rte.sdkconfig.mk
> index 2c071a2..6eb389c 100644
> --- a/mk/rte.sdkconfig.mk
> +++ b/mk/rte.sdkconfig.mk
> @@ -31,6 +31,12 @@
>   #
>   #  version: DPDK.L.1.2.3-3
>
> +.PHONY: showversion
> +showversion:
> +	@sed -rn 's,^#define RTE_VER_[A-Z_]*[[:space:]]+([0-9]+).*,\1,p' \
> +		$(RTE_SRCDIR)/lib/librte_eal/common/include/rte_version.h | \
> +		tr '\n' '.' | sed -r 's,\.([0-9]+)\.$$,r\1\n,'
> +
>   INSTALL_CONFIGS := $(filter-out %~,\
>   	$(patsubst $(RTE_SRCDIR)/config/defconfig_%,%,\
>   	$(wildcard $(RTE_SRCDIR)/config/defconfig_*)))
> diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
> index 905b678..b5126c0 100644
> --- a/mk/rte.sdkroot.mk
> +++ b/mk/rte.sdkroot.mk
> @@ -87,8 +87,8 @@ export ROOTDIRS-y ROOTDIRS- ROOTDIRS-n
>   .PHONY: default
>   default: all
>
> -.PHONY: config showconfigs
> -config showconfigs:
> +.PHONY: config showconfigs showversion
> +config showconfigs showversion:
>   	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkconfig.mk $@
>
>   .PHONY: test fast_test ring_test mempool_test
>

Re: [PATCH 1/2] mk: add rule to print version number

[Thomas Monjalon]

19/07/2013 21:18, Vincent JARDIN :
> Acked-by: vincent.jardin-pdR9zngts4EAvxtiuMwx3w@public.gmane.org

pushed

-- 
Thomas

Re: [PATCH 2/2] mk: insert version number in doxygen config

[Thomas Monjalon]

19/07/2013 21:17, Vincent JARDIN :
> Acked-by: vincent.jardin-pdR9zngts4EAvxtiuMwx3w@public.gmane.org

pushed

Now, the version number is shown on API doc:
	http://dpdk.org/doc/api/

-- 
Thomas