From 97d9251f69478bc72f176056747d9903bda28393 Mon Sep 17 00:00:00 2001 From: daimond113 <72147841+daimond113@users.noreply.github.com> Date: Fri, 3 Jan 2025 18:09:07 +0100 Subject: [PATCH] docs: remove branches from git revs --- docs/src/content/docs/guides/dependencies.mdx | 8 ++++---- docs/src/content/docs/reference/manifest.mdx | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/content/docs/guides/dependencies.mdx b/docs/src/content/docs/guides/dependencies.mdx index 08a1128..f8b736e 100644 --- a/docs/src/content/docs/guides/dependencies.mdx +++ b/docs/src/content/docs/guides/dependencies.mdx @@ -38,17 +38,17 @@ Git dependencies are dependencies on packages hosted on a Git repository. ```toml title="pesde.toml" [dependencies] -acme = { repo = "acme/package", rev = "main" } +acme = { repo = "acme/package", rev = "aeff6" } ``` In this example, we're specifying a dependency on the package contained within -the `acme/package` GitHub repository at the `main` branch. +the `acme/package` GitHub repository at the `aeff6` commit. -You can also use a URL to specify the Git repository and a specific commit. +You can also use a URL to specify the Git repository and a tag for the revision. ```toml title="pesde.toml" [dependencies] -acme = { repo = "https://git.acme.local/package.git", rev = "aeff6" } +acme = { repo = "https://git.acme.local/package.git", rev = "v0.1.0" } ``` You can also specify a path if the package is not at the root of the repository. diff --git a/docs/src/content/docs/reference/manifest.mdx b/docs/src/content/docs/reference/manifest.mdx index 528f4e1..dac80ac 100644 --- a/docs/src/content/docs/reference/manifest.mdx +++ b/docs/src/content/docs/reference/manifest.mdx @@ -372,14 +372,14 @@ foo = { wally = "acme/foo", version = "1.2.3", index = "acme" } ```toml [dependencies] -foo = { repo = "acme/packages", rev = "main", path = "foo" } +foo = { repo = "acme/packages", rev = "aeff6", path = "foo" } ``` **Git dependencies** contain the following fields: - `repo`: The URL of the Git repository. This can either be `/` for a GitHub repository, or a full URL. -- `rev`: The Git revision to install. This can be a branch, tag, or commit hash. +- `rev`: The Git revision to install. This can be a tag or commit hash. - `path`: The path within the repository to install. If not specified, the root of the repository is used.