Documentation Dependency Tracking Bug

Ralf Corsepius ralf.corsepius at rtems.org
Tue Feb 26 07:23:38 UTC 2013


On 02/25/2013 06:58 PM, Joel Sherrill wrote:
> On 2/25/2013 5:45 AM, Ralf Corsepius wrote:
>> On 02/24/2013 06:48 PM, Joel Sherrill wrote:
>>> Hi
>>>
>>> I was tidying up my patches to support both Texinfo 4.x and 5.x
>>> for RTEMS documentation when I noticed a bug in the Makefile's
>>> and confirmed they are present without my modifications.
>>>
>>> Each manual has a version.texi which is supposed to be dependent
>>> on the timestamp of that manual's main file.  So the C User's Guide
>>> is dependent on touching c_user.texi to update version.texi.
>> Not quite - This would be a pretty broken design ;-)
>>
>>
>> Instead, automake keeps timestamps as text inside of separate files,
>> named stamp-vti, which are not automatically updated, but supposed to be
>> manually updated by the "package maintainer".
>>
>> I.e. to update the timestamp files, the package maintainer is supposed
>> to do the following:
>>
>> mkdir BUILDDIR
>> <path-to-rtems>/configure --enable-maintainer-mode --enable-docs
>> cd doc/<subdir>
>> make maintainer-clean-vti
>> make stamp-vti
>>
>> Note: maintainer-clean-vti and stamp-vti are non-recursive and are only
>> available in maintainer-mode.
>>
> OK. This works.  Thanks.
>
> But it only works if you configure from the top of the tree.
> Building the doc using "..../doc/configure" has always worked fine. But
> if you use .../doc/configure, the commands in the stanza are commented
> out even with --enable-maintainer-mode and --enable-docs.
>
> You don't have to configure the documentation from the top of the tree
> except to regenerate the version.texi files. All of the documented
> procedures
> for generating documentation I am aware of configure using "doc/configure".
>
> Any idea why that doesn't let you regenerate the version.texi?

I don't get your point:

Try #1 (Toplevel VPATH-build)

# mkdir BUILD
# cd BUILD
# ../configure --enable-docs --enable-maintainer-mode
# cd doc/started
# make maintainer-clean-vti
rm -f ../../../doc/started/stamp-vti ../../../doc/started/version.texi
#  make stamp-vti
Updating ../../../doc/started/version.texi


Try #2 (doc subtree VPATH-build):

# mkdir BUILD
# cd BUILD
# ../doc/configure --enable-maintainer-mode
# cd started
# make maintainer-clean-vti
rm -f ../../doc/started/stamp-vti ../../doc/started/version.texi
# make stamp-vti
Updating ../../doc/started/version.texi

Try #3 (in-sourcetree doc-subtree build):
# cd doc
# ./configure --enable-maintainer-mode
# cd started
# make maintainer-clean-vti
rm -f ./stamp-vti ./version.texi
# make stamp-vti
Updating ./version.texi


Ralf




More information about the devel mailing list