gendoc infra: use $(pkgname) instead of explicitly passing 'manual'
authorThomas De Schampheleire <patrickdepinguin@gmail.com>
Fri, 15 Aug 2014 13:40:35 +0000 (15:40 +0200)
committerThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Sat, 16 Aug 2014 07:29:59 +0000 (09:29 +0200)
commitdd935d6771e3cdab15f997cd9f565d867343fa6f
treeda98d9a05c7dc236c67af247be12b861cd7b0149
parent3ed0eada71d4cb937d1f68c9af011aea5bff0e02
gendoc infra: use $(pkgname) instead of explicitly passing 'manual'

In the gendoc infrastructure, using an assignment of the form
    FOO = docs/$(1)/bar
inside GENDOC_INNER does not work as expected: the $(1) value is empty here
and the value of FOO becomes 'docs//bar'.

Parameters $(2), $(3), etc. do not have this problem. The specific thing
about $(1) is that it is a parameter to GENDOC itself (indicating the
document to create) and passed transparently to GENDOC_INNER.

This is different from the package infrastructures, where $(1) is set from
$(pkgname). In fact, the same strategy could be used by the gendoc
infrastructure as well, as $(pkgname) resolves to 'manual' for file
docs/manual/manual.mk. This has the advantage that the described problem
does not occur.

Note that this means that if we want to use the same GENDOC infrastructure
for another document, it will have to reside in a separate directory than
the manual.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Reviewed-by: Samuel Martin <s.martin49@gmail.com>
Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Tested-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
docs/manual/manual.mk