From 41751ecfcd65765433728673054b8a91f6993848 Mon Sep 17 00:00:00 2001 From: Oswaldo Rubio Date: Sat, 19 Aug 2023 18:10:28 +0200 Subject: [PATCH] updated doc --- README.md | 10 +++++----- Sources/jungle/Commands/CompareCommand.swift | 2 +- Sources/jungle/Commands/DependantCommand.swift | 2 +- Sources/jungle/Commands/GraphCommand.swift | 2 +- Sources/jungle/Commands/HistoryCommand.swift | 2 +- Sources/jungle/Commands/ModulesCommand.swift | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e3058f4..a39440b 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ ARGUMENTS: OPTIONS: --since Equivalent to git-log --since: Eg: '6 months ago' (default: 6 months ago) --module The Module to compare. If you specify something, target parameter will be ommited - --target The target in your Podfile file to be used + --target The target in your Podfile or Package.swift file to be used (this can be a Product name in SPM) --output-format csv or json (default: csv) --version Show the version. @@ -90,7 +90,7 @@ ARGUMENTS: OPTIONS: --to The git objects to compare the current graph to. Eg: - 'main', 'my_branch', 'some_commit_hash'. (default: HEAD, main, master) --module The Module to compare. If you specify something, target parameter will be ommited - --target The target in your Podfile or Package.swift file to be used + --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: Path to the directory where Podfile.lock or Package.swift is located (default: .) OPTIONS: - --target The target in your Podfile or Package.swift file to be used + --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: Path to the directory where Podfile.lock or Package.swift is located (default: .) OPTIONS: - --target The target in your Podfile or Package.swift file to be used + --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 A git object representing the version to draw the graph for. Eg: - 'main', 'my_branch', 'some_commit_hash'. --module The Module to compare. If you specify something, target parameter will be ommited - --target The target in your Podfile or Package.swift file to be used + --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 index 639c7fd..b0b1db4 100644 --- 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 index d481cce..9cf84a6 100644 --- 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 index b6c28d4..68c973f 100644 --- 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 index c8b1c08..1c1fc9b 100644 --- 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 index cb991af..0cb6be5 100644 --- 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")