From b90166cd45cbed6d512b1f9e3975f2011ff60a6e Mon Sep 17 00:00:00 2001 From: Remy Chantenay Date: Mon, 10 Apr 2023 16:27:15 +0200 Subject: [PATCH] Correct typos and minor improvements to README (#284) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Correct typos and minor improvements to README * Update crosslink/README.md Co-authored-by: Pablo Baeyens * Update crosslink/README.md Co-authored-by: Robert Pająk --------- Co-authored-by: Pablo Baeyens Co-authored-by: Robert Pająk --- crosslink/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/crosslink/README.md b/crosslink/README.md index a7732a17..1b1d0e2c 100644 --- a/crosslink/README.md +++ b/crosslink/README.md @@ -1,7 +1,7 @@ # Crosslink Crosslink is a tool to assist in managing go repositories that contain multiple -intra-reposistory go.mod files. Crosslink automatically scans and inserts +intra-repository `go.mod` files. Crosslink automatically scans and inserts replace statements for direct and transitive intra-repository dependencies. Crosslink also contains functionality to remove any extra replace statements that are no longer required within reason (see below). @@ -33,7 +33,7 @@ See [opentelemetry-go](https://github.com/open-telemetry/opentelemetry-go) and [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) for working examples. If you experience a use case that crosslink fails -too handle properly please open an issue (or even a PR!) highlighting +to handle properly, please open an issue (or even a PR!) highlighting the discrepancy. ## Usage @@ -48,12 +48,12 @@ Crosslink supports the following commands and flags. ### –-root -Used to provide the path to a directory where a go.mod file must exist. The +Used to provide the path to a directory where a `go.mod` file must exist. The root flag is available to all crosslink subcommands. -**Note: If no --root flag is provided than crosslink attempts to identify a git -repository in the current or a parent directory. If no git repository exists -crosslink will return an error.** +**Note: If no `--root` flag is provided then crosslink attempts to identify a git +repository in the current or a parent directory. +If no git repository exists, crosslink will return an error.** crosslink --root=/users/foo/multimodule-go-repo @@ -68,7 +68,7 @@ Pruning will only remove go modules that fall under the same module path as the root module. For example, If the root module is named `example.com/foo` and there exists a replace statement of `example.com/foo/bar => ./bar` that is not a direct or transitive -dependency of the current go.mod file, it will be pruned. +dependency of the current `go.mod` file, it will be pruned. **Crosslink will not remove replace statements for modules that do not fall under the root module path even if they are not in the current @@ -96,7 +96,7 @@ or update the corresponding replace statement for that requirement. ### –-exclude Exclude is a set of go modules that crosslink will ignore when replacing or pruning. -It is expected that a list of comma separated values will be provided in one or +It is expected that a list of comma-separated values will be provided in one or multiple calls to exclude. Excluded module names should be the old value in the replacement path. For example, passing `example.com/test` would exclude this replace statement from any operation `replace example.com/test => ./test`. @@ -126,5 +126,5 @@ Can be disabled when overwriting. crosslink --root=/users/foot/multimodule-go-repo --overwrite -v=false -**Quick Tip: Make sure your go.mod files are tracked and committed in a VCS +**Quick Tip: Make sure your `go.mod` files are tracked and committed in a VCS before running crosslink.**