Bug 13471

Batches of a few to 10 recipes updates ideally as the recipes are being done would be good.
If someone wants to do all of these in batches, that would be great.

I will work on this one.

I was thinking creating a batch patch. I feel having a patch for each recipe might be noisy in the git history?

Maxime, Thanks for taking on this work.
Perhaps it makes sense to do the work by directory:

$ ls -1 -d meta/recipes-* 
meta/recipes-bsp
meta/recipes-connectivity
meta/recipes-core
meta/recipes-devtools
meta/recipes-extended
meta/recipes-gnome
meta/recipes-graphics
meta/recipes-kernel
meta/recipes-multimedia
meta/recipes-rt
meta/recipes-sato
meta/recipes-support

and even by groups of ~ 10-20 recipes within those directories. 
That way you can send a few commits in at a time as you do the work. 
It will be a bit noisier but in some projects that I've worked on, commits that touch most of the files in a single commit can interfere with cherry-picking patches when doing maintenance.

It's your call and thanks again!

Hi Maxime,

Thanks again for working on this. 
I see your commits so far:

$ git log --oneline --author=maxime.roussinbelanger@gmail.com
b025b433c6 meta: add missing description for some recipes in graphics
5714e4fb5e meta: add missing description in recipes-gnome
9e5089dac1 meta: update and add missing homepage/bugtracker links
3a4a037450 meta: add missing description in recipes-extended
1c60c5744b shadow: update homepage and bugtracker
ca7570d8c3 meta: simplify over descriptive descriptions in devtools
57075f3ded meta: add missing some description in devtools
ec4fdfcc7b meta: add missing descriptions and homepage in bsp
e5f4e0df64 cmake: Use find_program if find_host_program is not available

Do you think you'll take time to finish the task?

Oh, it might be nice to have the layerindex report on missing homepages by layer.
   https://layers.openembedded.org/layerindex/about
but that should be a separate bug/enhancement.

(In reply to comment #4)
> Hi Maxime,

Hi Randy,

Sorry work has been crazy the last few months, taking more responsibility.

I'll continue to add more missing homepages/description.

I had a script running to check all the homepages that were not responding, so that's easy enough.

The descriptions are more work, but doable, to ease the work load I think I'll send smaller batches.
 
> 
> Thanks again for working on this. 
> I see your commits so far:
> 
> $ git log --oneline --author=maxime.roussinbelanger@gmail.com
> b025b433c6 meta: add missing description for some recipes in graphics
> 5714e4fb5e meta: add missing description in recipes-gnome
> 9e5089dac1 meta: update and add missing homepage/bugtracker links
> 3a4a037450 meta: add missing description in recipes-extended
> 1c60c5744b shadow: update homepage and bugtracker
> ca7570d8c3 meta: simplify over descriptive descriptions in devtools
> 57075f3ded meta: add missing some description in devtools
> ec4fdfcc7b meta: add missing descriptions and homepage in bsp
> e5f4e0df64 cmake: Use find_program if find_host_program is not available
> 
> Do you think you'll take time to finish the task?
> 
> Oh, it might be nice to have the layerindex report on missing homepages by
> layer.
>    https://layers.openembedded.org/layerindex/about

I went to look on that website, but I can't figure out what I should be looking for?

Thanks,
Max.

> but that should be a separate bug/enhancement.

Maxime,

Thanks for the update, it's been a crazy year and I understand that it's hard to make time for YP work but keep pushing. :)

Randy said
> > Oh, it might be nice to have the layerindex report on missing homepages by
> > layer.
> >    https://layers.openembedded.org/layerindex/about
>
> Maxime said: 
> I went to look on that website, but I can't figure out what I should be looking for?

I'm not sure at this point either! :)  I guess I was thinking that you'd try to
run the software that generates the layer index site and change it to either
report the recipes with missing info so that you don't have to go looking for them and/or generate a report per layer/repo about missing info. Does that make sense? It is somewhat beyond the scope of fixing the info but it could be useful.

I haven't tried to duplicate the layerindex so I'm not sure how much work it would be.
../Randy

(In reply to comment #6)
> Maxime,

Hello Randy!

> 
> Thanks for the update, it's been a crazy year and I understand that it's
> hard to make time for YP work but keep pushing. :)
> 
> Randy said
> > > Oh, it might be nice to have the layerindex report on missing homepages by
> > > layer.
> > >    https://layers.openembedded.org/layerindex/about
> >
> > Maxime said: 
> > I went to look on that website, but I can't figure out what I should be looking for?
> 
> I'm not sure at this point either! :)  I guess I was thinking that you'd try
> to
> run the software that generates the layer index site and change it to either
> report the recipes with missing info so that you don't have to go looking
> for them and/or generate a report per layer/repo about missing info. Does
> that make sense? It is somewhat beyond the scope of fixing the info but it
> could be useful.

Oh, I see what you mean now. If I choose this recipe: https://layers.openembedded.org/layerindex/recipe/555/

I see that the description is not available and there would be a way for me to figure out if a description is missing by regenerating this index on my side, with modifications. I see it now.

I went with the regex approach at the moment. Looking at all recipes that are missing the DESCRIPTION string. It has few drawbacks, one of them is I have to skip non-relevant files.

> 
> I haven't tried to duplicate the layerindex so I'm not sure how much work it

I think this way is way more reliable than the regex way.

Thanks!
Max.

> would be.
> ../Randy

Hello Randy,

I a found a new job and it means that I'll leave the Yocto environment. It was great while it lasted. I'll unassigned my-self from the ticket.

Great community!

Cheers!
Max.

Hi Maxime, Congratulations that's great news. Good luck and thanks for your contributions! -- Randy

Ida, Dorinda, Would one of you like to take this newcomer bug?

For future contributors, I modified the Django backend Randy talked about, the layer index. It was the easiest way I found to find recipes with missing descriptions. 

I modified those files to only get recipes with empty descriptions:

poky/bitbake/lib/toaster/orm/models.py
poky/bitbake/lib/toaster/toastergui/tables.py

Project.get_available_recipes
Project.get_all_compatible_recipes
LayerRecipesTable.setup_queryset

```
.filter(description__exact='')
```

The last time I checked, there were ~300 recipes with missing descriptions.

Cheers,
Max.

(In reply to comment #10)
> Ida, Dorinda, Would one of you like to take this newcomer bug?
Sure. I will.

Hi Ida,
I greped through recipes that don't have a DESCRIPTION and that's a lot, maybe we could work on it together taking sections. 
How about that :)

(In reply to comment #13)
> Hi Ida,
> I greped through recipes that don't have a DESCRIPTION and that's a lot,
> maybe we could work on it together taking sections. 
> How about that :)

Yes. We definitely should :)

It's really nice to see several commits merged to master fixing the homepage and descriptions! Are there more to do or should this bug be closed?

6db24928d6 recipes-support: Add missing HOMEPAGE and DESCRIPTION for recipes
dad63dcd37 recipes-sato: Add missing HOMEPAGE and DESCRIPTION for recipes
312994268b recipes-multimedia: Add missing HOMEPAGE and DESCRIPTION for recipes.
16409694f1 recipes-kernel: Add missing HOMEPAGE and DESCRIPTION for recipes.
24eac1fef8 recipes-graphics: Add missing HOMEPAGE and DESCRIPTION for recipes.
e501e87b84 recipes-gnome: Add missing HOMEPAGE and DESCRIPTION for recipes

It's the meta-openembedded layer that's left to be worked on.

Dorinda, 
Ah, well meta-openembedded devs have never wanted to track bugs in the YP wiki so please close this issue when you get a chance. 

Oh wait... Is there a test to report on the number of packages that do NOT have Homepage, description entries? That could be a separate bug, I suppose, it's up to you.

Okay will do, probably after the last patch series makes it's way into the source repository.

 Is there a test to report on the number of packages that do NOT have Homepage, description entries? That could be a separate bug

This is a cool idea, yes a separate bug entry, but there are something's to put into consideration, I noticed some recipes the likes of "meta/recipes-extended/images" does not have a homepage since there are no SRC_URI, and are not fetched from external sources. Would it be nice to make the test skip such recipes?

Yes, there will be exceptions such as:
   meta/recipes-extended/images

Perhaps it could be added to:
   meta/lib/oeqa/selftest/cases/distrodata.py
but I'm suggesting it because I was looking at that test recently.
I think that would be a good start. Try it out and reply here to if you like or send an RFC to the email list.

Note: That you should use the poky tree to do those tests until:
   https://bugzilla.yoctoproject.org/show_bug.cgi?id=14277
is resolved.

Alright, so i sent a RFC patch on the mailing list here:
https://lists.openembedded.org/g/openembedded-core/topic/81136066?p=,,,20,0,0,0::recentpostdate,,,20,2,0,0&allview=1

and with this test i could still find a few recipes that didn't have HOMEPAGE but i find it weird that the "check for recipes without DESCRIPTION" is being bypassed :\

if not rd.getVar('DESCRIPTION'):
     no_description.append((pn, fn))
if no_description:
     self.fail("""
The following recipes do not have a DESCRIPTION. Please add an entry for DESCRIPTION in the recipe.
""" + "\n".join(['%s (%s)' % i for i in no_description]))

To verify that recipes has HOMEPAGE or DESCRIPTION, this test has been added:
https://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=a6932c2203cf89f072b7e9a266fd22b384ece6a4