[PATCH v1] dts: add package mode config and updated README

[PATCH v1] dts: add package mode config and updated README

[Dean Marx]

In the current DTS setup description, the user installs poetry
with the --no-root option. However, adding 'package-mode = false'
to the pyproject.toml sets the same configuration, and running
poetry install --no-root will become an error in a future
poetry version.

Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
---
 dts/README.md      | 4 ++--
 dts/pyproject.toml | 1 +
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/dts/README.md b/dts/README.md
index ee3fa1c968..2b3a7f89c5 100644
--- a/dts/README.md
+++ b/dts/README.md
@@ -37,7 +37,7 @@ to allow you to connect to hosts without specifying a password.
 ```shell
 docker build --target dev -t dpdk-dts .
 docker run -v $(pwd)/..:/dpdk -v /home/dtsuser/.ssh:/root/.ssh:ro -it dpdk-dts bash
-$ poetry install --no-root
+$ poetry install
 $ poetry shell
 ```
 
@@ -46,7 +46,7 @@ $ poetry shell
 ```shell
 docker build --target dev -t dpdk-dts .
 docker run -v $(pwd)/..:/dpdk -it dpdk-dts bash
-$ poetry install --no-root
+$ poetry install
 $ poetry shell
 ```
 
diff --git a/dts/pyproject.toml b/dts/pyproject.toml
index 0b9b09805a..712af2f01d 100644
--- a/dts/pyproject.toml
+++ b/dts/pyproject.toml
@@ -3,6 +3,7 @@
 # Copyright(c) 2023 PANTHEON.tech s.r.o.
 
 [tool.poetry]
+package-mode = false
 name = "dts"
 version = "0.1.0"
 description = "DPDK Test Suite."
-- 
2.44.0

Re: [PATCH v1] dts: add package mode config and updated README

[Nicholas Pratte]

Reviewed-by: Nicholas Pratte <npratte@iol.unh.edu>

On Mon, Aug 12, 2024 at 12:35 PM Dean Marx <dmarx@iol.unh.edu> wrote:
>
> In the current DTS setup description, the user installs poetry
> with the --no-root option. However, adding 'package-mode = false'
> to the pyproject.toml sets the same configuration, and running
> poetry install --no-root will become an error in a future
> poetry version.
>
> Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
> ---
>  dts/README.md      | 4 ++--
>  dts/pyproject.toml | 1 +
>  2 files changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/dts/README.md b/dts/README.md
> index ee3fa1c968..2b3a7f89c5 100644
> --- a/dts/README.md
> +++ b/dts/README.md
> @@ -37,7 +37,7 @@ to allow you to connect to hosts without specifying a password.
>  ```shell
>  docker build --target dev -t dpdk-dts .
>  docker run -v $(pwd)/..:/dpdk -v /home/dtsuser/.ssh:/root/.ssh:ro -it dpdk-dts bash
> -$ poetry install --no-root
> +$ poetry install
>  $ poetry shell
>  ```
>
> @@ -46,7 +46,7 @@ $ poetry shell
>  ```shell
>  docker build --target dev -t dpdk-dts .
>  docker run -v $(pwd)/..:/dpdk -it dpdk-dts bash
> -$ poetry install --no-root
> +$ poetry install
>  $ poetry shell
>  ```
>
> diff --git a/dts/pyproject.toml b/dts/pyproject.toml
> index 0b9b09805a..712af2f01d 100644
> --- a/dts/pyproject.toml
> +++ b/dts/pyproject.toml
> @@ -3,6 +3,7 @@
>  # Copyright(c) 2023 PANTHEON.tech s.r.o.
>
>  [tool.poetry]
> +package-mode = false
>  name = "dts"
>  version = "0.1.0"
>  description = "DPDK Test Suite."
> --
> 2.44.0
>

Re: [PATCH v1] dts: add package mode config and updated README

[Luca Vizzarro]

Hi Dean,

Thank you! This looks good. You only missed to update the command line 
in the doc page under `doc/guides/tools/dst.rst`. This aside,

Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>

Re: [PATCH v1] dts: add package mode config and updated README

[Juraj Linkeš]

On 12. 8. 2024 18:35, Dean Marx wrote:
> In the current DTS setup description, the user installs poetry
> with the --no-root option. However, adding 'package-mode = false'
> to the pyproject.toml sets the same configuration, and running
> poetry install --no-root will become an error in a future
> poetry version.
> 
> Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
> ---
>   dts/README.md      | 4 ++--
>   dts/pyproject.toml | 1 +
>   2 files changed, 3 insertions(+), 2 deletions(-)

As Luca mentioned, there are three instances you missed in 
doc/guides/tools/dts.rst.

And one instance in dts/.devcontainer/devcontainer.json.

[PATCH v2] dts: add package mode config and updated docs

[Dean Marx]

In the current DTS setup description, the user installs poetry
with the --no-root option. However, adding 'package-mode = false'
to the pyproject.toml sets the same configuration, and running
poetry install --no-root will become an error in a future
poetry version.

Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
Reviewed-by: Nicholas Pratte <npratte@iol.unh.edu>
Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
---
 doc/guides/tools/dts.rst            | 6 +++---
 dts/.devcontainer/devcontainer.json | 2 +-
 dts/README.md                       | 4 ++--
 dts/pyproject.toml                  | 1 +
 4 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 8008c9f74d..65cce9e5ed 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -92,7 +92,7 @@ Setting up DTS environment
 
    .. code-block:: console
 
-      poetry install --no-root
+      poetry install
       poetry shell
 
 #. **SSH Connection**
@@ -449,8 +449,8 @@ The :ref:`doc build dependencies <doc_dependencies>` may be installed with Poetr
 
 .. code-block:: console
 
-   poetry install --no-root --only docs
-   poetry install --no-root --with docs  # an alternative that will also install DTS dependencies
+   poetry install --only docs
+   poetry install --with docs  # an alternative that will also install DTS dependencies
    poetry shell
 
 After executing the meson command, build the documentation with:
diff --git a/dts/.devcontainer/devcontainer.json b/dts/.devcontainer/devcontainer.json
index 4d737f1b40..d96b4fdab2 100644
--- a/dts/.devcontainer/devcontainer.json
+++ b/dts/.devcontainer/devcontainer.json
@@ -13,7 +13,7 @@
 	// "forwardPorts": [],
 
 	// The next line runs commands after the container is created - in our case, installing dependencies.
-	"postCreateCommand": "poetry install --no-root",
+	"postCreateCommand": "poetry install",
 
 	"extensions": [
 		"ms-python.vscode-pylance",
diff --git a/dts/README.md b/dts/README.md
index ee3fa1c968..2b3a7f89c5 100644
--- a/dts/README.md
+++ b/dts/README.md
@@ -37,7 +37,7 @@ to allow you to connect to hosts without specifying a password.
 ```shell
 docker build --target dev -t dpdk-dts .
 docker run -v $(pwd)/..:/dpdk -v /home/dtsuser/.ssh:/root/.ssh:ro -it dpdk-dts bash
-$ poetry install --no-root
+$ poetry install
 $ poetry shell
 ```
 
@@ -46,7 +46,7 @@ $ poetry shell
 ```shell
 docker build --target dev -t dpdk-dts .
 docker run -v $(pwd)/..:/dpdk -it dpdk-dts bash
-$ poetry install --no-root
+$ poetry install
 $ poetry shell
 ```
 
diff --git a/dts/pyproject.toml b/dts/pyproject.toml
index 38281f0e39..91d459f573 100644
--- a/dts/pyproject.toml
+++ b/dts/pyproject.toml
@@ -3,6 +3,7 @@
 # Copyright(c) 2023 PANTHEON.tech s.r.o.
 
 [tool.poetry]
+package-mode = false
 name = "dts"
 version = "0.1.0"
 description = "DPDK Test Suite."
-- 
2.44.0

Re: [PATCH v2] dts: add package mode config and updated docs

[Juraj Linkeš]

On 18. 9. 2024 22:19, Dean Marx wrote:
> In the current DTS setup description, the user installs poetry
> with the --no-root option. However, adding 'package-mode = false'
> to the pyproject.toml sets the same configuration, and running
> poetry install --no-root will become an error in a future
> poetry version.
> 
> Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
> Reviewed-by: Nicholas Pratte <npratte@iol.unh.edu>
> Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
> ---

Reviewed-by: Juraj Linkeš <juraj.linkes@pantheon.tech>

Applied to next-dts, thanks.