You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@harmony.apache.org by "Mark Hindess (JIRA)" <ji...@apache.org> on 2006/03/01 20:10:40 UTC

[jira] Created: (HARMONY-146) doxygen build is broken

doxygen build is broken
-----------------------

         Key: HARMONY-146
         URL: http://issues.apache.org/jira/browse/HARMONY-146
     Project: Harmony
        Type: Bug
  Components: Classlib  
    Reporter: Mark Hindess
    Priority: Trivial


I thought I'd have broke nthe doc/build.xml doxygen generation with my shared code moves but when I went to check I discovered that it was already broken.  I've fixed it to at least point to the correct directories now.


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


doxygen doc (was: Re: [jira] Created: (HARMONY-146) doxygen build is broken)

Posted by Tim Ellison <t....@gmail.com>.
Mark Hindess wrote:
> On 01/03/06, George Harley <ge...@googlemail.com> wrote:
>> Hi,
>>
>> When did it break ?
> 
> "cd doc;ant" reports:
> 
>   doxygen-kernel:
>        [exec] Error: tag INPUT: input source
>                `/pbuilder/tmp/Harmony.quilt/doc/../java-src/kernel/src'
> does not exist
>        [exec] Result: 1
> 
> So it's probably been broken a while.
> 
> There is a disinsentive for people to run the doc build as it replaces
> the kernel_doc and vm_doc directories from svn causing svn commands to
> fail with:
> 
>   svn: Working copy 'doc/vm_doc' is missing or not locked
> 
> You then have to remove the doc/vm_doc (and doc/kernel_doc) directory
> by hand before svn will work again.
> 
> Since these are generated files they probably shouldn't be in svn in
> the first place.  Though I can see why it is handy to have them there.
>  Perhaps we need a "snapshot" on the web site?

Yes, the docs were checked in from day one, but only the support files
should be in SVN under classlib, and the generated doc should be
snapshotted(?) onto the documentation website.

(Today the docs are linked from the classlib doc site [1] under
'Architecture and Guides')

[1]
http://incubator.apache.org/harmony/subcomponents/classlibrary/index.html

Regards,
Tim

>> Was it something the automated build process have informed us about ?
> 
> The build is currently only doing "cd make; ant".  I can add the doc
> build but at the moment the ant tasks are configured to ignore
> failures so the build wouldn't actually break.
> 
> As I mention in the patch comment, there is also a bit of work to do
> to fix up the grouping of documentation by adding appropriate
> DoxygenSupport files.  I was going to submit a patch to copy them from
> the native-src/linux.IA32 subdirs to the native-src/shared subdirs but
> I think it needs a little more thought with respect to groups
> particularly for new modules like auth.
> 
> Regards,
>  Mark.
> 
>> Mark Hindess (JIRA) wrote:
>>> doxygen build is broken
>>> -----------------------
>>>
>>>          Key: HARMONY-146
>>>          URL: http://issues.apache.org/jira/browse/HARMONY-146
>>>      Project: Harmony
>>>         Type: Bug
>>>   Components: Classlib
>>>     Reporter: Mark Hindess
>>>     Priority: Trivial
>>>
>>>
>>> I thought I'd have broke nthe doc/build.xml doxygen generation with my shared code moves but when I went to check I discovered that it was already broken.  I've fixed it to at least point to the correct directories now.
>>>
>>>
>>>
>>
> 
> 
> --
> Mark Hindess <ma...@googlemail.com>
> IBM Java Technology Centre, UK.
> 

-- 

Tim Ellison (t.p.ellison@gmail.com)
IBM Java technology centre, UK.

Re: [jira] Created: (HARMONY-146) doxygen build is broken

Posted by Mark Hindess <ma...@googlemail.com>.
On 01/03/06, Stuart Ballard <st...@gmail.com> wrote:
> Mark Hindess <mark.hindess <at> googlemail.com> writes:
>
> > Since these are generated files they probably shouldn't be in svn in
> > the first place.  Though I can see why it is handy to have them there.
> >  Perhaps we need a "snapshot" on the web site?
> >
> > > Was it something the automated build process have informed us about ?
> >
> > The build is currently only doing "cd make; ant".  I can add the doc
> > build but at the moment the ant tasks are configured to ignore
> > failures so the build wouldn't actually break.
>
> I thought the results of the builds were already in
> http://cvs.apache.org/dist/incubator/harmony/snapshots/
>
> That's what I've been using for Japi results. I did notice that the last run
> was from Feb 17th, but I thought that was just because no automated build was
> running.
>
> If there *is* an automated build running, could its output be made available
> somewhere so the Japi results can be based on the latest CVS rather than two
> weeks old?

Hi Stuart,

Sorry for the confusion.

George was referring to the builds I'm running.  These are not public.
 But I have configured them to send status emails to the list just to
help catch build breaks early - though they aren't getting through
yet.

As Geir has said, the builds for the project should be running on
Apache infrastructure and then the jars can be published on Apache
servers but AFAIK there are no firm plans to do this yet.

In the meantime,  Tim will continue to make periodic snapshots with
announcements sent to this list.  Any JAPI results you produce based
on these snapshots will be very much appreciated.

Regards,
 Mark.

--
Mark Hindess <ma...@googlemail.com>
IBM Java Technology Centre, UK.

Re: [jira] Created: (HARMONY-146) doxygen build is broken

Posted by Stuart Ballard <st...@gmail.com>.
Mark Hindess <mark.hindess <at> googlemail.com> writes:

> Since these are generated files they probably shouldn't be in svn in
> the first place.  Though I can see why it is handy to have them there.
>  Perhaps we need a "snapshot" on the web site?
> 
> > Was it something the automated build process have informed us about ?
> 
> The build is currently only doing "cd make; ant".  I can add the doc
> build but at the moment the ant tasks are configured to ignore
> failures so the build wouldn't actually break.

I thought the results of the builds were already in
http://cvs.apache.org/dist/incubator/harmony/snapshots/

That's what I've been using for Japi results. I did notice that the last run
was from Feb 17th, but I thought that was just because no automated build was
running.

If there *is* an automated build running, could its output be made available
somewhere so the Japi results can be based on the latest CVS rather than two
weeks old?

Thanks,
Stuart.



Re: [jira] Created: (HARMONY-146) doxygen build is broken

Posted by Mark Hindess <ma...@googlemail.com>.
On 01/03/06, George Harley <ge...@googlemail.com> wrote:
> Hi,
>
> When did it break ?

"cd doc;ant" reports:

  doxygen-kernel:
       [exec] Error: tag INPUT: input source
               `/pbuilder/tmp/Harmony.quilt/doc/../java-src/kernel/src'
does not exist
       [exec] Result: 1

So it's probably been broken a while.

There is a disinsentive for people to run the doc build as it replaces
the kernel_doc and vm_doc directories from svn causing svn commands to
fail with:

  svn: Working copy 'doc/vm_doc' is missing or not locked

You then have to remove the doc/vm_doc (and doc/kernel_doc) directory
by hand before svn will work again.

Since these are generated files they probably shouldn't be in svn in
the first place.  Though I can see why it is handy to have them there.
 Perhaps we need a "snapshot" on the web site?

> Was it something the automated build process have informed us about ?

The build is currently only doing "cd make; ant".  I can add the doc
build but at the moment the ant tasks are configured to ignore
failures so the build wouldn't actually break.

As I mention in the patch comment, there is also a bit of work to do
to fix up the grouping of documentation by adding appropriate
DoxygenSupport files.  I was going to submit a patch to copy them from
the native-src/linux.IA32 subdirs to the native-src/shared subdirs but
I think it needs a little more thought with respect to groups
particularly for new modules like auth.

Regards,
 Mark.

> Mark Hindess (JIRA) wrote:
> > doxygen build is broken
> > -----------------------
> >
> >          Key: HARMONY-146
> >          URL: http://issues.apache.org/jira/browse/HARMONY-146
> >      Project: Harmony
> >         Type: Bug
> >   Components: Classlib
> >     Reporter: Mark Hindess
> >     Priority: Trivial
> >
> >
> > I thought I'd have broke nthe doc/build.xml doxygen generation with my shared code moves but when I went to check I discovered that it was already broken.  I've fixed it to at least point to the correct directories now.
> >
> >
> >
>
>


--
Mark Hindess <ma...@googlemail.com>
IBM Java Technology Centre, UK.

Re: [jira] Created: (HARMONY-146) doxygen build is broken

Posted by George Harley <ge...@googlemail.com>.
Hi,

When did it break ? Was it something the automated build process have 
informed us about ?

Best regards,
George
IBM UK

Mark Hindess (JIRA) wrote:
> doxygen build is broken
> -----------------------
>
>          Key: HARMONY-146
>          URL: http://issues.apache.org/jira/browse/HARMONY-146
>      Project: Harmony
>         Type: Bug
>   Components: Classlib  
>     Reporter: Mark Hindess
>     Priority: Trivial
>
>
> I thought I'd have broke nthe doc/build.xml doxygen generation with my shared code moves but when I went to check I discovered that it was already broken.  I've fixed it to at least point to the correct directories now.
>
>
>   


[jira] Updated: (HARMONY-146) doxygen build is broken

Posted by "Mark Hindess (JIRA)" <ji...@apache.org>.
     [ http://issues.apache.org/jira/browse/HARMONY-146?page=all ]

Mark Hindess updated HARMONY-146:
---------------------------------

    Attachment: fix.doxygen

Fixes the directory names.  There is no doubt plenty more work to be done in this area.  For instance, adding DoxygenSupport.txt to directories to group documentation appropriately.
(md5sum=120e303eb29eb40705e2fc0ded6b0c67)


> doxygen build is broken
> -----------------------
>
>          Key: HARMONY-146
>          URL: http://issues.apache.org/jira/browse/HARMONY-146
>      Project: Harmony
>         Type: Bug
>   Components: Classlib
>     Reporter: Mark Hindess
>     Priority: Trivial
>  Attachments: fix.doxygen
>
> I thought I'd have broke nthe doc/build.xml doxygen generation with my shared code moves but when I went to check I discovered that it was already broken.  I've fixed it to at least point to the correct directories now.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira