[jira] Updated: (DERBY-4875) cross-manual xref problems after doc build change

["Rick Hillegas (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DERBY-4875?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas updated DERBY-4875:
---------------------------------

    Attachment: derby-4875-02-aa-copyDevguideFirst.diff

Attaching derby-4875-02-aa-copyDevguideFirst.diff. This patch fixes the errors still seen when you run the pdf.ref and html.ref targets before running the corresponding devguide targets. Committed at subversion revision 1029722.

When the Reference Guide is built, it is assumed that the source for the Developer's Guide sits in a directory right next to the Reference Guide source. The original parameterizing change worked by copying files from the src tree into corresponding directories in the temp_source tree, replacing the @TOKEN@ variables during the copy. Just building the Reference Guide by itself meant that temp_source had a sources for the Reference Guide but temp_source did not have a corresponding subdirectory for the Developer's Guide.

This patch makes us copy the Developer's Guide over to temp_source before copying the Reference Guide. After applying this patch, you see that the top level devguide cruft is created when you build the Reference Guide now.

At some point, we may want to unravel why the docs build creates this top level devguide directory. We should do what we did to the code client, and root all build artifacts in a subdirectory which can be relocated. The top level devguide artifact should be deleted when you clobber the client. But those changes are another issue for another day. When we tackle those changes, it may be interesting to know that the top level devguide artifact is created by the pipeline task in the "debug" target in DITA-OT1.1.2.1/pretargets.xml


Touches the following file:

M      build.xml


> cross-manual xref problems after doc build change
> -------------------------------------------------
>
>                 Key: DERBY-4875
>                 URL: https://issues.apache.org/jira/browse/DERBY-4875
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.7.1.0
>            Reporter: Dag H. Wanvik
>            Assignee: Rick Hillegas
>         Attachments: derby-4875-01-aa-dontDeleteLastTemp.diff, derby-4875-02-aa-copyDevguideFirst.diff
>
>
> See thread http://old.nabble.com/Problems-with-docs-build-tt30078424.html#a30078424
> Possible cause (http://old.nabble.com/forum/Permalink.jtp?root=30078424&post=30082083&page=y)
> > After the patch, there is a new preprocessing step, that puts the
> > sources in a temp directory (from doc.properties):
> >
> >     temp.source=${basedir}/temp_source
> One problem is that after preprocessing of "ref", the references to
> devguide are assumed to be present as ../devguide, cf. the generated
> dita.list (snippet below). But the way the preprocessing is currently
> done, there is only one manual at a time inside temp_source.
> Presumably, since refs were not resolved, the devguide directory is also
> missing as observed.
> Dag
> Snippet of trunk/temp/dita.list (seen while processing html.ref, inside
> target "debug" of DITA../pretargets.xml, which calls module
> DebugAndFilter):
> rrefsqlj30540.dita,../devguide/cdevcsecuregrantrevokeaccess.dita,rrefjdbc37352.dita
> and then I see this warning:
> [xslt]
> /export/home/dag/java/sb/docs/trunk/DITA-OT1.1.2.1/xsl/preprocess/topicpull.xsl:410:27:
> Warning! Can not load requested doc:
> /export/home/dag/java/sb/docs/trunk/temp/../devguide/cdevcsecuregrantrevokeaccess.dita
> (No such file or directory)

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.