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

Message ID 20240812163538.29904-1-dmarx@iol.unh.edu (mailing list archive)
State Superseded
Delegated to: Juraj Linkeš
Headers
Series [v1] dts: add package mode config and updated README |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS

Commit Message

Dean Marx Aug. 12, 2024, 4:35 p.m. UTC
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(-)
  

Comments

Nicholas Pratte Aug. 12, 2024, 6:55 p.m. UTC | #1
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
>
  
Luca Vizzarro Sept. 11, 2024, 3:33 p.m. UTC | #2
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>
  
Juraj Linkeš Sept. 16, 2024, 10:10 a.m. UTC | #3
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

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."