Re: [Pharo-dev] Package comments

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-dev] Package comments

Nicolas Cellier


2015-05-06 13:08 GMT+02:00 Marcus Denker <[hidden email]>:

> On 06 May 2015, at 10:53, Christophe Demarey <[hidden email]> wrote:
>
>
> Le 5 mai 2015 à 17:14, Kasper Osterbye a écrit :
>
>> Marcus Denker-4 wrote
>>> Right now we do not have yet Package comments.
>>>
>>> But we should!
>>>
>>> MBInfo seems to be a private class of Versionner…
>>>
>>> For package comments we first need to evaluate the design space…
>>> e.g. where to store it in the image, how to store it in Monticello…
>>
>> OK - Makes sense.
>>
>> From my perspective, the key to getting this of the ground is to make sure
>> such comments can be written and read in Nautilus. The package objects used
>> in Nautilus are from "RPackage".
>> Thus, the problem, in my view reduces to:
>> a) How to make room in RPackage for a comment field (add one more IV)
>> b) How to integrate the storage of this field in connection with Monticello
>> as Marcus writes.
>
> I don't think is the good way to do that.
> We are working on adding meta-data to packages. These meta-data includes a package description (or comment) but also a lot of other data.
> You will not be able to store everything in rpackage inst. var. And of course, there is also the problem that Monticello is not able to store meta-data (e.g. STON files).
> For now, the best option is to use a PackageManifest.
>
> If you want to allow package comments in Nautilus, I would display the content of the description method of the package manifest if available.
>

Yes… this could be the easiest for now.

Then as a second step, we add support to store resources in Monticello.

        Marcus



Adding metadata to MC  cannot be very difficult, MC already carries plenty of metadata ;)
Coordination with other dialects (squeak/gemstone/...) would be welcome, because i'm sure that every dialect would benefit from package comments, or already has package comments (vw along with many other properties).
No long discussion required, if no consensus, just let Pharo lead.
I remember that Bert has experimented adding a comment to PackageInfo, but I don't know in which state it did end up (MC-wise).

Nicolas