Re: [Minios-devel] About Outreachy intern contribution for "Enhanced Profiling and Tracing Support for Unikraft"

[Ray LI <ray4opensource@xxxxxxxxx>]

Hi Lars,

I have almost finished proposing a patch about user's document, but I met a problem when I sent emails to the list. But I am going to try to figure it out tomorrow. As for that small task, if I understood it correctly, the task is made up with two parts,

1. Write some text document about the build system API.
2. Use sphinx to generate the API documentation.

And the final result of it is like user's guide. Is that correct?

Regards,

Ray

On Fri, Feb 16, 2018 at 8:32 PM, Lars Kurth <lars.kurth.xen@xxxxxxxxx> wrote:

Ray,

> During next Wednesday night to Thursday morning (21/02-22/02) I am flying back to  Sydney. Thus, it won’t work for me.  The other days are okay for me.

Mon-Wed is too early for Simon and The does not work for you. Should we aim for next Friday 23rd? 

We were thinking of a small task: adding support for the generation of automated API documentation in the build system would help you understand the build and configure system. You will need to understand this part for the project (besides the actual tracing technology). We would prefer sphinx (http://www.sphinx-doc.org/en/master/, https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-i-5/), with doxygen as an alternative. 

This may also require (defer decision  to Simon)

* Docs annotation at least one API to see whether this works

* Possibly a document which explains how to build the API docs

* Possibly additions to the CODING STYLE file

Regards

Lars

On 15 Feb 2018, at 15:25, Ray LI <ray4opensource@xxxxxxxxx> wrote:

Hey Simon, 

I read intro part of  unikraft_doc again, and I found the answer to my question. I will post the question here in case that someone else have the same question as me.

My question is that:

The following picture is captured from the User's guide

<1518704066165.jpg>
​  

The unikraft-libs here is the same as the lib directory in the following picture?

<1518704358517.jpg>
​

And the answer is YES.

Ray

On Thu, Feb 15, 2018 at 4:51 PM, Ray LI <ray4opensource@xxxxxxxxx> wrote:

Hey Simon,

It depends on the date actually. During next Wednesday night to Thursday morning (21/02-22/02) I am flying back to  Sydney. Thus, it won’t work for me.  The other days are okay for me.

Oh my bad. I will send some pictures about my question to you later. That would be more clear.

Thanks

Ray 

Simon Kuenzer <simon.kuenzer@xxxxxxxxx>于2018年2月15日 周四下午3:30写道：

Hey would Thursday work for you too?

Unfortunately, I did not get your question. Which lib variable do you
mean? In which file do you want to specify it?

Thanks,

Simon

On 15.02.2018 04:16, Ray LI wrote:
> Hey Lars,
>
> For me, if we make an appointment in advance, I would be available from
> 19:00 on Mon/Tue/Wed.
>
> Ray
>
> On Thu, Feb 15, 2018 at 12:54 AM, Lars Kurth <lars.kurth.xen@xxxxxxxxx
> <mailto:lars.kurth.xen@gmail.com>> wrote:
>
>
>
>     > On 14 Feb 2018, at 16:04, Ray LI <ray4opensource@xxxxxxxxx <mailto:ray4opensource@gmail.com>> wrote:
>     >
>     > Yes, Lars. It seems perfect for me. Will we have a discussion as soon as possible or after I finish my first week task?
>     >
>     > Ray
>
>     Depends on Simon: he is rather busy this week, so I would say we
>     sync on Mon/Tue/Wed, if he is available. Propose a few time slots
>     after 19:00 for those days
>     Lars
>
>

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