From bcb0a8e3e34cad4b1533260f3f2e2c59a1c36eea Mon Sep 17 00:00:00 2001 From: d4v1d03 Date: Wed, 29 May 2024 15:44:36 +0530 Subject: [PATCH] minor changes regarding the deprecated kpm Signed-off-by: d4v1d03 --- docs/kpm_sparse_checkout.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/kpm_sparse_checkout.md b/docs/kpm_sparse_checkout.md index 968787a1..d4b15de9 100644 --- a/docs/kpm_sparse_checkout.md +++ b/docs/kpm_sparse_checkout.md @@ -13,7 +13,7 @@ We will try to keep the command line interface as simple and straightforward as - Adding a Dependency : The following command will lead to the addition of a dependency: -`kpm add ` +`kcl mod add ` This command will add the specified subdirectory as a dependency in the current KCL project. @@ -24,7 +24,7 @@ In addition to the command line interface, users can specify subdirectory depend Considering the nginx-ingres module, on typing the command ``` -kpm add https://github.com/kcl-lang/modules/tree/main/nginx-ingress /restrict-ingress-anotations +kcl mod add https://github.com/kcl-lang/modules/tree/main/nginx-ingress /restrict-ingress-anotations ``` The following command will lead to the addition of restrict-ingress-anotations package to the current KCL project and will update the kcl.mod accordingly. @@ -42,7 +42,7 @@ my_dependency = { git = "https://github.com/example/repo", subdirectory = "path/ ``` ## 5. Specifying how kcl.mod will specify the added subdirectories -To support the specification of a subdirectory for dependencies that are sourced from Git repositories, we need to extend the kcl.mod file structure. This involves adding an optional `subdirectory` field under each dependency. This can be manually edited or automatically updated by the kpm add command. +To support the specification of a subdirectory for dependencies that are sourced from Git repositories, we need to extend the kcl.mod file structure. This involves adding an optional `subdirectory` field under each dependency. This can be manually edited or automatically updated by the kcl mod add command. A sample kcl mod for the same would look like this.