scrollkeeper-devel

[Scrollkeeper-devel] category codes

[Laszlo K. - S. I. <las...@su...>]

Hi All,

It's been a long time, but recently I had to look at some issues the Sun 
docs team had with Scrollkeeper.

I noticed that install.c:add_doc_to_content_list() uses the titles 
content list entries to insert docs into them. I think this is exactly 
what the category codes (in the OMF files) have been designed for. The 
category codes should identify the sections where docs should be 
inserted, they should be the same for all the locales. Titles are 
different in every locale so they either don't work or impose extra 
translation effort on package maintainers (category entries in OMF files 
need translation).

Or am I missing something?

Laszlo

Re: [Scrollkeeper-devel] category codes

[Malcolm T. <ma...@co...>]

On Fri, 2003-08-22 at 22:06, Laszlo Kovacs - Sun Ireland wrote:
> Hi All,
> 
> It's been a long time, but recently I had to look at some issues the Sun 
> docs team had with Scrollkeeper.

Welcome back (even if only briefly). :-)

Grrr. These would be the issues that they have not put into the bug
tracker so that nobody else can see them or fix them? I recently
received some patches from Glynn Foster that have been bouncing around
Sun for a while, too, that I had never seen before. Please, please,
please encourage whoever works with Scrollkeeper at Sun to use the bug
tracker so that things get fixed at the source.

I have reduced the number of outstanding bugs in the tracker by a large
number recently (from around 50 to about a dozen), so they do get read
and acted upon.

> I noticed that install.c:add_doc_to_content_list() uses the titles 
> content list entries to insert docs into them. I think this is exactly 
> what the category codes (in the OMF files) have been designed for. The 
> category codes should identify the sections where docs should be 
> inserted, they should be the same for all the locales. Titles are 
> different in every locale so they either don't work or impose extra 
> translation effort on package maintainers (category entries in OMF files 
> need translation).
> 
> Or am I missing something?

This sounds convincing. I'll have a look at it. I thought it should be
working that way, too, so if it's not it may just be a bug.

Cheers,
Malcolm

Re: [Scrollkeeper-devel] category codes

[Malcolm T. <ma...@co...>]

On Sat, 2003-08-23 at 13:51, Malcolm Tredinnick wrote:
> On Fri, 2003-08-22 at 22:06, Laszlo Kovacs - Sun Ireland wrote:
> > Hi All,
> > 
> > It's been a long time, but recently I had to look at some issues the Sun 
> > docs team had with Scrollkeeper.
[...]
> 
> Grrr. These would be the issues that they have not put into the bug
> tracker so that nobody else can see them or fix them? 

I apologise: this was rude. I am taking my frustrations out on the wrong
person.

Malcolm

Re: [Scrollkeeper-devel] category codes

[Laszlo K. - S. I. <las...@su...>]

> Welcome back (even if only briefly). :-)
> 
> Grrr. These would be the issues that they have not put into the bug
> tracker so that nobody else can see them or fix them? I recently
> received some patches from Glynn Foster that have been bouncing around
> Sun for a while, too, that I had never seen before. Please, please,
> please encourage whoever works with Scrollkeeper at Sun to use the bug
> tracker so that things get fixed at the source.

Ok, I'll try. Be cautious with those patches (check them before checking 
them in) from Glynn, some of them might be incorrect (I saw at least one 
that is). Nothing to do with Glynn really, he is just passing patches 
that he gets from the docs team. The problem is that in the last two 
years (while Sun pulled me from Gnome) nobody worked consistently 
with/on Scrollkeeper here so it kind of fell on the floor. This should 
improve now a bit.

> 
> I have reduced the number of outstanding bugs in the tracker by a large
> number recently (from around 50 to about a dozen), so they do get read
> and acted upon.
> 
> 
>>I noticed that install.c:add_doc_to_content_list() uses the titles 
>>content list entries to insert docs into them. I think this is exactly 
>>what the category codes (in the OMF files) have been designed for. The 
>>category codes should identify the sections where docs should be 
>>inserted, they should be the same for all the locales. Titles are 
>>different in every locale so they either don't work or impose extra 
>>translation effort on package maintainers (category entries in OMF files 
>>need translation).
>>
>>Or am I missing something?
> 
> 
> This sounds convincing. I'll have a look at it. I thought it should be
> working that way, too, so if it's not it may just be a bug.

I'll log a bug in the tracker. I don't have a proper patch yet, but when 
I will have one I will add it there.

Thanks for the help.

Laszlo

Re: [Scrollkeeper-devel] category codes

[Malcolm T. <ma...@co...>]

On Mon, 2003-08-25 at 17:56, Laszlo Kovacs - Sun Ireland wrote:
> > Welcome back (even if only briefly). :-)
> > 
> > Grrr. These would be the issues that they have not put into the bug
> > tracker so that nobody else can see them or fix them? I recently
> > received some patches from Glynn Foster that have been bouncing around
> > Sun for a while, too, that I had never seen before. Please, please,
> > please encourage whoever works with Scrollkeeper at Sun to use the bug
> > tracker so that things get fixed at the source.
> 
> Ok, I'll try. Be cautious with those patches (check them before checking 
> them in) from Glynn, some of them might be incorrect (I saw at least one 
> that is). Nothing to do with Glynn really, he is just passing patches 
> that he gets from the docs team.

Yeah, I undertood that Glynn was just the messenger. The patches
themselves were mostly things that were already in CVS or that I had
existing patches for (I think one was new and that's still on my pile of
things to review). So I think we're being careful enough. 

In any case, just receiving patches -- no matter what the quality -- is
always good. Worst case, it often shows another way to think about
things, so I am always going to encourage it.

>  The problem is that in the last two 
> years (while Sun pulled me from Gnome) nobody worked consistently 
> with/on Scrollkeeper here so it kind of fell on the floor. This should 
> improve now a bit.

Cool. :-)

Cheers,
Malcolm

Re: [Scrollkeeper-devel] category codes

[Laszlo K. - S. I. <las...@su...>]

I sticked a patch with a fix into the tracker.

Laszlo