You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by Kim Haase <Ca...@Sun.COM> on 2008/04/01 00:06:36 UTC

Re: some comments on the 10.4 beta distribution

Good catches, Rick. Should there be a a JIRA issue for this? Or perhaps 
more than one? I think only the first two are specific to the docs. 
Also, which NOTICE are we talking about? The one in the code trunk seems 
to have been updated, and the one in the docs trunk doesn't have a 
copyright notice.

Kim

Rick Hillegas wrote:
> I have downloaded the source distribution of the 10.4 beta and have a 
> couple comments. After unpacking this distribution, I was able to build 
> the docs and I was able to generate a release. The links from index.html 
> worked. So the structure of the beta looks good to me. The release notes 
> looked sketchy, but I've already sent mail about that. In addition, the 
> following looked odd:
> 
> o In the user guides, should "Copyright 2004-2007" be changed to 
> "Copyright 2004-2008"?
> 
> o The version number in the user documentation is 10.3, not 10.4
> 
> o In the JDBC3 public api, there's a spurious line just before the title 
> of the top-left frame. The line reads: 'Apache Derby 10.4 API 
> Documentation">'
> 
> o The NOTICE file says "Copyright 2004-2007". Should that be changed to 
> "Copyright 2004-2008"?
> 
> Thanks,
> -Rick

Re: some comments on the 10.4 beta distribution

Posted by Kim Haase <Ca...@Sun.COM>.
Oh no ... I see the failure too.

I found the problem -- I have incorrect capital letters in a 
cross-reference in src/ref/rrefattribstartmaster.dita:

<i><xref 
href="rrefattribslaveHost.dita#rrefattribslaveHost">slaveHost=hostname</xref></i>

I'm really sorry -- I mostly test on Windows, where the docs build twice 
as fast as on my Solaris box (dare I admit?), and where the problem does 
not occur. On Solaris I have been doing a sanity test just building the 
HTML, and the problem does not occur there either. Now I know to make 
sure to build the doc completely on a Unix box before checking in.

I will make the fix. DERBY-3169 is still open for additional changes.

Kim

Dyre.Tjeldvoll@Sun.COM wrote:
> Dyre.Tjeldvoll@Sun.COM writes:
> 
>> Dyre.Tjeldvoll@Sun.COM writes:
>>
>>> Dyre.Tjeldvoll@Sun.COM writes:
>>>
>>>> Kim Haase <Ca...@Sun.COM> writes:
>>>>
>>>>> Good catches, Rick. Should there be a a JIRA issue for this? Or
>>>>> perhaps more than one? I think only the first two are specific to the
>>>>> docs. Also, which NOTICE are we talking about? The one in the code
>>>>> trunk seems to have been updated, and the one in the docs trunk
>>>>> doesn't have a copyright notice.
>>>> I'm wondering how much of this is covered by step 1 under 
>>>> 'Check-ins just before generating release artifacts' in the relase
>>>> instructions on the Wiki:
>>>>
>>>> http://wiki.apache.org/db-derby/DerbySnapshotOrRelease
>>> Those instructions are actually a bit terse. The actual wording is 
>>>
>>> "Also adjust version numbers in documentation by modifying the
>>> appropriate *conrefs.dita files."
>>>
>>> There are actually a number of such files
>>>
>>> dt136804@khepri32~/derby/docs-10.4$ find . -name '*conrefs.dita'
>>> ./src/ja_JP/getstart/gsconrefs.dita
>>> ./src/ja_JP/conrefs.dita
>>> ./src/pt_BR/adminguide/adminconrefs.dita
>>> ./src/pt_BR/ref/refconrefs.dita
>>> ./src/pt_BR/getstart/gsconrefs.dita
>>> ./src/conrefs.dita
>>> ./conrefs.dita
>>>
>>> I assume that only those under src are of interest. Seems only two files
>>> actually conatin the string '10.3':
>>> M      src/conrefs.dita
>>> M      src/ja_JP/conrefs.dita
>>>
>>> If that's all that needs to be done, I can check in the change.
>> Actually, I can't because I can no longer build the 10.4 doc branch. I
>> was trying to figure out what had happened, but now svn seems to be
>> down... 
> 
> svn is back up and it seems like the following revision introduced the
> problem:
> 
> dt136804@khepri32~/derby/docs-10.4$ svn log -r 641931
> ------------------------------------------------------------------------
> r641931 | chaase3 | 2008-03-27 19:15:04 +0100 (Thu, 27 Mar 2008) | 4 lines
> 
> DERBY-3169: Add documentation for replication
> 
> New files for Admin Guide, Reference Manual, Tuning Derby; modified Derby properties table in Tuning Guide.
> 
> ------------------------------------------------------------------------
> 
> Do I need a new DITA version or something to build after this?
> 
> The error message I get is:
> 
> BUILD FAILED
> /export/home/tmp/derby/docs-10.4/build.xml:196: The following error occurred while executing this line:
> /export/home/tmp/derby/docs-10.4/build.xml:215: The following error occurred while executing this line:
> /export/home/tmp/derby/docs-10.4/DITA-OT1.1.2.1/conductor.xml:209: The following error occurred while executing this line:
> /export/home/tmp/derby/docs-10.4/DITA-OT1.1.2.1/ditatargets.xml:78: javax.xml.transform.TransformerException: org.apache.fop.fo.ValidationException: file:///export/home/tmp/derby/docs-10.4/out/ref/refderby.fo:6749:258: Error(6749/258): fo:basic-link, Missing attribute:  Either external-destination or internal-destination must be specified.
> 
> Total time: 8 minutes 40 seconds
> 

Re: some comments on the 10.4 beta distribution

Posted by Dy...@Sun.COM.
Dyre.Tjeldvoll@Sun.COM writes:

> Dyre.Tjeldvoll@Sun.COM writes:
>
>> Dyre.Tjeldvoll@Sun.COM writes:
>>
>>> Kim Haase <Ca...@Sun.COM> writes:
>>>
>>>> Good catches, Rick. Should there be a a JIRA issue for this? Or
>>>> perhaps more than one? I think only the first two are specific to the
>>>> docs. Also, which NOTICE are we talking about? The one in the code
>>>> trunk seems to have been updated, and the one in the docs trunk
>>>> doesn't have a copyright notice.
>>>
>>> I'm wondering how much of this is covered by step 1 under 
>>> 'Check-ins just before generating release artifacts' in the relase
>>> instructions on the Wiki:
>>>
>>> http://wiki.apache.org/db-derby/DerbySnapshotOrRelease
>>
>> Those instructions are actually a bit terse. The actual wording is 
>>
>> "Also adjust version numbers in documentation by modifying the
>> appropriate *conrefs.dita files."
>>
>> There are actually a number of such files
>>
>> dt136804@khepri32~/derby/docs-10.4$ find . -name '*conrefs.dita'
>> ./src/ja_JP/getstart/gsconrefs.dita
>> ./src/ja_JP/conrefs.dita
>> ./src/pt_BR/adminguide/adminconrefs.dita
>> ./src/pt_BR/ref/refconrefs.dita
>> ./src/pt_BR/getstart/gsconrefs.dita
>> ./src/conrefs.dita
>> ./conrefs.dita
>>
>> I assume that only those under src are of interest. Seems only two files
>> actually conatin the string '10.3':
>> M      src/conrefs.dita
>> M      src/ja_JP/conrefs.dita
>>
>> If that's all that needs to be done, I can check in the change.
>
> Actually, I can't because I can no longer build the 10.4 doc branch. I
> was trying to figure out what had happened, but now svn seems to be
> down... 

svn is back up and it seems like the following revision introduced the
problem:

dt136804@khepri32~/derby/docs-10.4$ svn log -r 641931
------------------------------------------------------------------------
r641931 | chaase3 | 2008-03-27 19:15:04 +0100 (Thu, 27 Mar 2008) | 4 lines

DERBY-3169: Add documentation for replication

New files for Admin Guide, Reference Manual, Tuning Derby; modified Derby properties table in Tuning Guide.

------------------------------------------------------------------------

Do I need a new DITA version or something to build after this?

The error message I get is:

BUILD FAILED
/export/home/tmp/derby/docs-10.4/build.xml:196: The following error occurred while executing this line:
/export/home/tmp/derby/docs-10.4/build.xml:215: The following error occurred while executing this line:
/export/home/tmp/derby/docs-10.4/DITA-OT1.1.2.1/conductor.xml:209: The following error occurred while executing this line:
/export/home/tmp/derby/docs-10.4/DITA-OT1.1.2.1/ditatargets.xml:78: javax.xml.transform.TransformerException: org.apache.fop.fo.ValidationException: file:///export/home/tmp/derby/docs-10.4/out/ref/refderby.fo:6749:258: Error(6749/258): fo:basic-link, Missing attribute:  Either external-destination or internal-destination must be specified.

Total time: 8 minutes 40 seconds

-- 
dt

Re: some comments on the 10.4 beta distribution

Posted by Dy...@Sun.COM.
Dyre.Tjeldvoll@Sun.COM writes:

> Dyre.Tjeldvoll@Sun.COM writes:
>
>> Kim Haase <Ca...@Sun.COM> writes:
>>
>>> Good catches, Rick. Should there be a a JIRA issue for this? Or
>>> perhaps more than one? I think only the first two are specific to the
>>> docs. Also, which NOTICE are we talking about? The one in the code
>>> trunk seems to have been updated, and the one in the docs trunk
>>> doesn't have a copyright notice.
>>
>> I'm wondering how much of this is covered by step 1 under 
>> 'Check-ins just before generating release artifacts' in the relase
>> instructions on the Wiki:
>>
>> http://wiki.apache.org/db-derby/DerbySnapshotOrRelease
>
> Those instructions are actually a bit terse. The actual wording is 
>
> "Also adjust version numbers in documentation by modifying the
> appropriate *conrefs.dita files."
>
> There are actually a number of such files
>
> dt136804@khepri32~/derby/docs-10.4$ find . -name '*conrefs.dita'
> ./src/ja_JP/getstart/gsconrefs.dita
> ./src/ja_JP/conrefs.dita
> ./src/pt_BR/adminguide/adminconrefs.dita
> ./src/pt_BR/ref/refconrefs.dita
> ./src/pt_BR/getstart/gsconrefs.dita
> ./src/conrefs.dita
> ./conrefs.dita
>
> I assume that only those under src are of interest. Seems only two files
> actually conatin the string '10.3':
> M      src/conrefs.dita
> M      src/ja_JP/conrefs.dita
>
> If that's all that needs to be done, I can check in the change.

Actually, I can't because I can no longer build the 10.4 doc branch. I
was trying to figure out what had happened, but now svn seems to be
down... 

-- 
dt

Re: some comments on the 10.4 beta distribution

Posted by Dy...@Sun.COM.
Dyre.Tjeldvoll@Sun.COM writes:

> Kim Haase <Ca...@Sun.COM> writes:
>
>> Good catches, Rick. Should there be a a JIRA issue for this? Or
>> perhaps more than one? I think only the first two are specific to the
>> docs. Also, which NOTICE are we talking about? The one in the code
>> trunk seems to have been updated, and the one in the docs trunk
>> doesn't have a copyright notice.
>
> I'm wondering how much of this is covered by step 1 under 
> 'Check-ins just before generating release artifacts' in the relase
> instructions on the Wiki:
>
> http://wiki.apache.org/db-derby/DerbySnapshotOrRelease

Those instructions are actually a bit terse. The actual wording is 

"Also adjust version numbers in documentation by modifying the
appropriate *conrefs.dita files."

There are actually a number of such files

dt136804@khepri32~/derby/docs-10.4$ find . -name '*conrefs.dita'
./src/ja_JP/getstart/gsconrefs.dita
./src/ja_JP/conrefs.dita
./src/pt_BR/adminguide/adminconrefs.dita
./src/pt_BR/ref/refconrefs.dita
./src/pt_BR/getstart/gsconrefs.dita
./src/conrefs.dita
./conrefs.dita

I assume that only those under src are of interest. Seems only two files
actually conatin the string '10.3':
M      src/conrefs.dita
M      src/ja_JP/conrefs.dita

If that's all that needs to be done, I can check in the change.

>
> I didn't do that for the beta, since it is listed as something you do
> when creating the release candidate. But I guess those files might as well have
> been updated right after cutting the branch... (and possibly updated
> later).



>
>>
>> Kim
>>
>> Rick Hillegas wrote:
>>> I have downloaded the source distribution of the 10.4 beta and have
>>> a couple comments. After unpacking this distribution, I was able to
>>> build the docs and I was able to generate a release. The links from
>>> index.html worked. So the structure of the beta looks good to
>>> me. The release notes looked sketchy, but I've already sent mail
>>> about that. In addition, the following looked odd:
>>>
>>> o In the user guides, should "Copyright 2004-2007" be changed to
>>> "Copyright 2004-2008"?
>>>
>>> o The version number in the user documentation is 10.3, not 10.4
>>>
>>> o In the JDBC3 public api, there's a spurious line just before the
>>> title of the top-left frame. The line reads: 'Apache Derby 10.4 API
>>> Documentation">'
>>>
>>> o The NOTICE file says "Copyright 2004-2007". Should that be changed
>>> to "Copyright 2004-2008"?
>>>
>>> Thanks,
>>> -Rick
>>
>
> -- 
> dt
>

-- 
dt

Re: some comments on the 10.4 beta distribution

Posted by Dy...@Sun.COM.
Kim Haase <Ca...@Sun.COM> writes:

> Good catches, Rick. Should there be a a JIRA issue for this? Or
> perhaps more than one? I think only the first two are specific to the
> docs. Also, which NOTICE are we talking about? The one in the code
> trunk seems to have been updated, and the one in the docs trunk
> doesn't have a copyright notice.

I'm wondering how much of this is covered by step 1 under 
'Check-ins just before generating release artifacts' in the relase
instructions on the Wiki:

http://wiki.apache.org/db-derby/DerbySnapshotOrRelease

I didn't do that for the beta, since it is listed as something you do
when creating the release candidate. But I guess those files might as well have
been updated right after cutting the branch... (and possibly updated
later).

>
> Kim
>
> Rick Hillegas wrote:
>> I have downloaded the source distribution of the 10.4 beta and have
>> a couple comments. After unpacking this distribution, I was able to
>> build the docs and I was able to generate a release. The links from
>> index.html worked. So the structure of the beta looks good to
>> me. The release notes looked sketchy, but I've already sent mail
>> about that. In addition, the following looked odd:
>>
>> o In the user guides, should "Copyright 2004-2007" be changed to
>> "Copyright 2004-2008"?
>>
>> o The version number in the user documentation is 10.3, not 10.4
>>
>> o In the JDBC3 public api, there's a spurious line just before the
>> title of the top-left frame. The line reads: 'Apache Derby 10.4 API
>> Documentation">'
>>
>> o The NOTICE file says "Copyright 2004-2007". Should that be changed
>> to "Copyright 2004-2008"?
>>
>> Thanks,
>> -Rick
>

-- 
dt