Re: [Minios-devel] [UNIKRAFT PATCH v4 2/4] doc: Add section about symbol exporting

[Florian Schmidt <Florian.Schmidt@xxxxxxxxx>]

Hi Yuri,

On 08/24/2018 03:31 PM, Yuri Volchkov wrote:
> Florian Schmidt <Florian.Schmidt@xxxxxxxxx> writes:
>
> > On 08/24/2018 01:11 PM, Simon Kuenzer wrote:
> > > +Unikraft provides separate namespaces for each library. This means that
> > > +every function and variable is only be visible and linkable internally.
> > remove the "be".
> or add "will" :)
but only if you also remove the "is" then ;-)
Honestly though: both are fine, don't care which one.

> > > +In case of application, this file need to have just the "main"
> > > +function. For a library all API functions must be present there.
> > If you're writing an application, you need to add the "main" as the entry
> > point from unikraft into this file, but most likely no other functions.
> > For a library, all external API functions must be listed here.
> How about this:
>
> If you're writing an application, you need to add the "main" into this
> file. Most likely nothing else should be there.
>
> For a library, all external API functions must be listed.
That sounds good.

> > > +You can change the location if this file by defining the
> > > +``APPNAME_EXPORTS`` variable with the path to it. This is helpful in case
> > > +multiple libraries are sharing the same base folder or this symbol file
> > > +is part of a remotely fetched archive.
> > _of_ this file. Also, "with the path to it" isn't 100% clear I think.
> > Does it mean I have to give a full path? Can optionally five a full
> > path, but can also give a relative one? Only the path or also the file name?
> Is this one better?
>
> You could override the default path of this file by defining the
I think it should be "can" here.

> ``APPNAME_EXPORTS``. The path must be either absolute (use
> APPNAME_BASE), or relative to the unikraft sources dir.
>
> For the sake of file structure consistency, it is not recommended to
> change the default path, unless it is really necessary. For example if
> multiple libraries are sharing the same base folder or this symbol file
> is part of a remotely fetched archive.
Otherwise, this sounds good and gives good design considerations.

Think we converged now to something that is v2-able? In that case, 
consider this reviewed, and thus the whole patch series.
Cheers,
Florian

_______________________________________________
Minios-devel mailing list
Minios-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/minios-devel