updated doc

xing · Aug 19, 2023 · 41751ec · 41751ec
1 parent 9fae3c5
commit 41751ec
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ ARGUMENTS:
 OPTIONS:
   --since <since>         Equivalent to git-log --since: Eg: '6 months ago' (default: 6 months ago)
   --module <module>       The Module to compare. If you specify something, target parameter will be ommited
-  --target <target>       The target in your Podfile file to be used
+  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
   --output-format <output-format>
                           csv or json (default: csv)
   --version               Show the version.
@@ -90,7 +90,7 @@ ARGUMENTS:
 OPTIONS:
   --to <git-object>       The git objects to compare the current graph to. Eg: - 'main', 'my_branch', 'some_commit_hash'. (default: HEAD, main, master)
   --module <module>       The Module to compare. If you specify something, target parameter will be ommited
-  --target <target>       The target in your Podfile or Package.swift file to be used
+  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
   --version               Show the version.
   -h, --help              Show help information.
 ```
@@ -127,7 +127,7 @@ ARGUMENTS:
   <directory-path>        Path to the directory where Podfile.lock or Package.swift is located (default: .)
 
 OPTIONS:
-  --target <target>       The target in your Podfile or Package.swift file to be used
+  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
   --version               Show the version.
   -h, --help              Show help information.
 
@@ -157,7 +157,7 @@ ARGUMENTS:
   <directory-path>        Path to the directory where Podfile.lock or Package.swift is located (default: .)
 
 OPTIONS:
-  --target <target>       The target in your Podfile or Package.swift file to be used
+  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
   --show-only-tests       Show only Test targets
   --version               Show the version.
   -h, --help              Show help information.
@@ -185,7 +185,7 @@ ARGUMENTS:
 OPTIONS:
   --of <git-object>       A git object representing the version to draw the graph for. Eg: - 'main', 'my_branch', 'some_commit_hash'.
   --module <module>       The Module to compare. If you specify something, target parameter will be ommited
-  --target <target>       The target in your Podfile or Package.swift file to be used
+  --target <target>       The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)
   --use-multiedge         Use multi-edge or unique-edge configuration
   --show-externals        Show Externals modules dependencies
   --version               Show the version.

diff --git a/Sources/jungle/Commands/CompareCommand.swift b/Sources/jungle/Commands/CompareCommand.swift
@@ -35,7 +35,7 @@ struct CompareCommand: ParsableCommand {
     @Option(help: "The Module to compare. If you specify something, target parameter will be ommited")
     var module: String?
 
-    @Option(help: "The target in your Podfile or Package.swift file to be used")
+    @Option(help: "The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)")
     var target: String
 
     @Flag(help: "Use multi-edge or unique-edge configuration")

diff --git a/Sources/jungle/Commands/DependantCommand.swift b/Sources/jungle/Commands/DependantCommand.swift
@@ -11,7 +11,7 @@ struct DependantCommand: ParsableCommand {
         abstract: "Outputs a sorted list of targets that depends on the specified one in target"
     )
 
-    @Option(help: "The target in your Podfile or Package.swift file to be used")
+    @Option(help: "The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)")
     var target: String
 
     @Flag(help: "Show only Test targets")

diff --git a/Sources/jungle/Commands/GraphCommand.swift b/Sources/jungle/Commands/GraphCommand.swift
@@ -21,7 +21,7 @@ struct GraphCommand: ParsableCommand {
     @Option(help: "The Module to compare. If you specify something, target parameter will be ommited")
     var module: String?
 
-    @Option(help: "The target in your Podfile or Package.swift file to be used")
+    @Option(help: "The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)")
     var target: String
 
     @Flag(help: "Use multi-edge or unique-edge configuration")

diff --git a/Sources/jungle/Commands/HistoryCommand.swift b/Sources/jungle/Commands/HistoryCommand.swift
@@ -24,7 +24,7 @@ struct HistoryCommand: AsyncParsableCommand {
     @Option(help: "The Module to compare. If you specify something, target parameter will be ommited")
     var module: String?
 
-    @Option(help: "The target in your Podfile file to be used")
+    @Option(help: "The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)")
     var target: String
 
     @Flag(help: "Use multi-edge or unique-edge configuration")

diff --git a/Sources/jungle/Commands/ModulesCommand.swift b/Sources/jungle/Commands/ModulesCommand.swift
@@ -13,7 +13,7 @@ struct ModulesCommand: ParsableCommand {
         abstract: "Outputs a sorted list of modules dependencies count of your project"
     )
 
-    @Option(help: "The target in your Podfile or Package.swift file to be used")
+    @Option(help: "The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM)")
     var target: String
 
     @Argument(help: "Path to the directory where Podfile.lock or Package.swift is located")