From beaf708a50b528b4f30058b19f26d6378b5c561e Mon Sep 17 00:00:00 2001 From: mishraprafful Date: Wed, 2 Feb 2022 15:47:15 +0100 Subject: [PATCH 1/3] Add example for lakectl tag create command --- cmd/lakectl/cmd/tag.go | 7 ++++--- docs/reference/commands.md | 7 +++++++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/cmd/lakectl/cmd/tag.go b/cmd/lakectl/cmd/tag.go index bb156b531d2..cf549e309d6 100644 --- a/cmd/lakectl/cmd/tag.go +++ b/cmd/lakectl/cmd/tag.go @@ -61,9 +61,10 @@ var tagListCmd = &cobra.Command{ } var tagCreateCmd = &cobra.Command{ - Use: "create ", - Short: "Create a new tag in a repository", - Args: cobra.ExactArgs(tagCreateRequiredArgs), + Use: "create ", + Short: "Create a new tag in a repository", + Example: "lakectl tag create lakefs://some-repo-name/some-tag-name 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917", + Args: cobra.ExactArgs(tagCreateRequiredArgs), Run: func(cmd *cobra.Command, args []string) { tagURI := MustParseRefURI("tag", args[0]) Fmt("Tag ref: %s\n", tagURI.String()) diff --git a/docs/reference/commands.md b/docs/reference/commands.md index de5441906fd..85f3f85257c 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -2541,6 +2541,13 @@ Create a new tag in a repository lakectl tag create [flags] ``` +#### Examples +{:.no_toc} + +``` +lakectl tag create lakefs://some-repo-name/some-tag-name 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917 +``` + #### Options {:.no_toc} From b119e786dc2a86c21e317061b501f406d137396e Mon Sep 17 00:00:00 2001 From: Prafful Mishra <32913433+mishraprafful@users.noreply.github.com> Date: Fri, 11 Feb 2022 14:41:13 +0100 Subject: [PATCH 2/3] Update example repo name to confirm to other example standards Co-authored-by: johnnyaug --- cmd/lakectl/cmd/tag.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/lakectl/cmd/tag.go b/cmd/lakectl/cmd/tag.go index cf549e309d6..1946b444e12 100644 --- a/cmd/lakectl/cmd/tag.go +++ b/cmd/lakectl/cmd/tag.go @@ -63,7 +63,7 @@ var tagListCmd = &cobra.Command{ var tagCreateCmd = &cobra.Command{ Use: "create ", Short: "Create a new tag in a repository", - Example: "lakectl tag create lakefs://some-repo-name/some-tag-name 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917", + Example: "lakectl tag create lakefs://example-repo/example-tag 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917", Args: cobra.ExactArgs(tagCreateRequiredArgs), Run: func(cmd *cobra.Command, args []string) { tagURI := MustParseRefURI("tag", args[0]) From 24d59f6180eb7c12a09e65a2d9bd1ce888925514 Mon Sep 17 00:00:00 2001 From: mishraprafful Date: Fri, 11 Feb 2022 15:18:46 +0100 Subject: [PATCH 3/3] Update docs for example command name change --- docs/reference/commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/commands.md b/docs/reference/commands.md index 85f3f85257c..daa639ebe42 100644 --- a/docs/reference/commands.md +++ b/docs/reference/commands.md @@ -2545,7 +2545,7 @@ lakectl tag create [flags] {:.no_toc} ``` -lakectl tag create lakefs://some-repo-name/some-tag-name 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917 +lakectl tag create lakefs://example-repo/example-tag 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917 ``` #### Options