From cfe17402dedd044d421616b467781197fd0a3e0f Mon Sep 17 00:00:00 2001 From: Javier Carrasco Date: Tue, 12 Mar 2024 21:45:58 +0100 Subject: [PATCH 1/3] poky-entry.py: fix typo in help Signed-off-by: Javier Carrasco --- poky-entry.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/poky-entry.py b/poky-entry.py index 56cc755..14054bf 100755 --- a/poky-entry.py +++ b/poky-entry.py @@ -25,7 +25,7 @@ parser = argparse.ArgumentParser() parser.add_argument('--workdir', default='/home/pokyuser', help='The active directory once the container is running. ' - 'In the abscence of the "id" argument, the uid and ' + 'In the absence of the "id" argument, the uid and ' 'gid of the workdir will also be used for the user ' 'in the container.') From be6b3f6ba0fd15f713de1b009201e63f6bd2f7ce Mon Sep 17 00:00:00 2001 From: Javier Carrasco Date: Tue, 12 Mar 2024 21:46:08 +0100 Subject: [PATCH 2/3] README.md: add missing options Signed-off-by: Javier Carrasco --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79a0e5e..e3c986a 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,14 @@ point. docker run --rm -it -v myvolume:/workdir crops/poky --workdir=/workdir ``` - Let's discuss the options: - * **_--workdir=/workdir_**: This causes the container to start in the directory + Available options: + * **_--help_**: show help message and exit. + * **_--workdir=WORKDIR_**: This causes the container to start in the directory specified. This can be any directory in the container. The container will also use the uid and gid of the workdir as the uid and gid of the user in the container. + * **_--id=ID_**: uid and gid to use for the user inside the container. It should be in the form uid:gid. - This should put you at a prompt similar to: + The previous example should put you at a prompt similar to: ``` pokyuser@3bbac563cacd:/workdir$ ``` From 5b0796b1e1759b625aa0886a8c9a7524ab7d2a30 Mon Sep 17 00:00:00 2001 From: Javier Carrasco Date: Tue, 12 Mar 2024 21:45:38 +0100 Subject: [PATCH 3/3] README.md: clarify aim of poky-container It has been reported that developers new to containers try to obtain meta-data inside the poky-container, which leads to users reporting false errors. Specify the goal of poky-container and explicitly state that meta-data must be retrieved outside the container. Fixes: Bugzilla - Bug 11385 Closes: https://bugzilla.yoctoproject.org/show_bug.cgi?id=11385 Suggested-by: Henry Bruce Signed-off-by: Javier Carrasco --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3c986a..ea0652f 100644 --- a/README.md +++ b/README.md @@ -69,4 +69,7 @@ point. pokyuser@3bbac563cacd:/workdir$ ``` At this point you should be able to follow the same instructions as described - in https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html + in https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#building-your-image to build an image. + + Note that the container should not be used to clone Poky or obtain any other meta-data, which must be done + _outside_ the container using common tools like Git, as stated in https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#use-git-to-clone-poky