[oi-dev] should packages have a pkg.description or not?

[Till Wegmüller]

Hi Tim

Welcome to the community.

pkg.description is a longer version of pkg.summary. In OpenIndiana we
use highlevel scripts to write these attributes.

Looking at our standard templates under templates directory in
oi-userland I see that they are not using any Property for the
Description. But some components do. But it does not seem to translate
into the final manifest.

We have a documentation of these highlevel scripts under
https://wiki.openindiana.org/oi/Building+with+oi-userland

The scripts themselves are at https://github.com/openindiana/oi-userland

Have a look around.

I would say that if we use pkg.description additionally to pkg.summary
then we would just need to fix oi-userland scripts. There are a lot of
COMPONENT_DESCRITION variables already in oi-userland. It should stay
optional though as The Disgners has designed the Property to be optional.

Greetings
Till
On 01/11/19 08:08 PM, Tim Mooney wrote:
> 
> All-
> 
> I'm new to oi-dev, though I've been on oi-discuss for years and have done
> a little bit with oi-userland in the past.
> 
> My basic question is: Should we be including a package description
> (pkg.description) in new packages we contribute, or should it
> intentionally be left un-set?  Currently, some packages have a
> pkg.description, but many do not.  I want to do it the "right" way, but
> it's not clear to me which way that is.
> 
> I've done some searching of the oi-dev archives, but I don't see any
> threads that discuss pkg.description.
> 
> Thanks,
> 
> Tim