Re: [Minios-devel] [UNIKRAFT PATCH v3 doc_edit] Users.rst: clean up ambiguities related to path set-up

[Simon Kuenzer <simon.kuenzer@xxxxxxxxx>]

Hey Ray,

thanks for your resubmission. Please note that each revision of your 
patch has to apply directly to the upstream repository. We do not 
include each revision after another, we just take the accepted last one.
For formatting the patch subject, please have another look to 
CONTRIBUTING.md. We specify the patch target with a selector. So, your 
subject line should look like:
"[UNIKRAFT PATCH v4] doc/users: Explain purpose of UK_ROOT and UK_LIBS"

On 23.02.2018 13:37, Ray LI wrote:
> Documented that UK_LIBS is not needed unless an external library is used.
>
> Signed-off-by: Ray LI <ray4opensource@xxxxxxxxx>
>
> ---
> Changed since v2:
>         * Fixed typo errors in v1.
> ---
>   doc/guides/users.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/guides/users.rst b/doc/guides/users.rst
> index 2d347ce..f55626a 100644
> --- a/doc/guides/users.rst
> +++ b/doc/guides/users.rst
> @@ -20,7 +20,7 @@ Unikraft app has its own repo): ::
>   
>   Now edit the Makefile in the app directory. In particular, set the
>   ``UK_ROOT`` and ``UK_LIBS`` variables to point to the directories where you
> -cloned the repos above. Noted that if you don't use external libraries, you 
> don't need to edit ``UK_LIBS`` variable. It is just for external libraries.For 
> instance, assuming the following directory
> +cloned the repos above. Note that if you don't use the external libraries, you 
> won't need to edit the
 ``UK_LIBS`` variable. Otherwise, you will need to make it point to the 
externl library directory. For instance, assuming the following directory
Actually, I would change this paragraph in a way that we would explain 
the purpose of both variables. The reader might be able to distinguish 
them then right away:
Now edit the Makefile in the app directory. In particular, set the
``UK_ROOT`` and ``UK_LIBS`` variables. ``UK_ROOT`` should point to the 
base directory of the cloned Unikraft repository. If you want to include 
external libraries (which is optional) you should point ``UK_LIBS`` to 
the base directory of them. For instance, assuming the following 
directory structure ::

>   structure ::
>   
>     ├── unikraft
What do you think?

Thanks,

Simon

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