From 558f999b00ed22f8c95ea5cd98ddfd1dc6b0a972 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 10:48:33 +0200 Subject: [PATCH 1/6] add sparse url in cargo package header --- docs/content/usage/packages/cargo.en-us.md | 5 ++++- docs/content/usage/packages/cargo.zh-cn.md | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/content/usage/packages/cargo.en-us.md b/docs/content/usage/packages/cargo.en-us.md index d5c2fab6fd458..e74e35c16d88f 100644 --- a/docs/content/usage/packages/cargo.en-us.md +++ b/docs/content/usage/packages/cargo.en-us.md @@ -50,7 +50,10 @@ Add the following text to the configuration file located in the current users ho default = "gitea" [registries.gitea] -index = "https://gitea.example.com/{owner}/_cargo-index.git" +index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git +# index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index + + [net] git-fetch-with-cli = true diff --git a/docs/content/usage/packages/cargo.zh-cn.md b/docs/content/usage/packages/cargo.zh-cn.md index 126dfd370a334..527eaaebecf90 100644 --- a/docs/content/usage/packages/cargo.zh-cn.md +++ b/docs/content/usage/packages/cargo.zh-cn.md @@ -50,7 +50,8 @@ Cargo 将可用软件包的信息存储在一个存储在 git 仓库中的软件 default = "gitea" [registries.gitea] -index = "https://gitea.example.com/{owner}/_cargo-index.git" +index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git +# index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index [net] git-fetch-with-cli = true From 038f390f7984512a259d5bcb116962576fa97f16 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 10:57:10 +0200 Subject: [PATCH 2/6] use sparse as default --- docs/content/usage/packages/cargo.en-us.md | 4 ++-- docs/content/usage/packages/cargo.zh-cn.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/content/usage/packages/cargo.en-us.md b/docs/content/usage/packages/cargo.en-us.md index e74e35c16d88f..8d1d55cabe80b 100644 --- a/docs/content/usage/packages/cargo.en-us.md +++ b/docs/content/usage/packages/cargo.en-us.md @@ -50,8 +50,8 @@ Add the following text to the configuration file located in the current users ho default = "gitea" [registries.gitea] -index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git -# index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index +index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index +# index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git diff --git a/docs/content/usage/packages/cargo.zh-cn.md b/docs/content/usage/packages/cargo.zh-cn.md index 527eaaebecf90..285fe9c8b3729 100644 --- a/docs/content/usage/packages/cargo.zh-cn.md +++ b/docs/content/usage/packages/cargo.zh-cn.md @@ -50,8 +50,8 @@ Cargo 将可用软件包的信息存储在一个存储在 git 仓库中的软件 default = "gitea" [registries.gitea] -index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git -# index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index +index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index +# index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git [net] git-fetch-with-cli = true From 69c6ab7fcb5e3697d8804b5b6f4daac2324ba5a5 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 11:03:14 +0200 Subject: [PATCH 3/6] remove excessive line returns --- docs/content/usage/packages/cargo.en-us.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/content/usage/packages/cargo.en-us.md b/docs/content/usage/packages/cargo.en-us.md index 8d1d55cabe80b..e0ae6c30de450 100644 --- a/docs/content/usage/packages/cargo.en-us.md +++ b/docs/content/usage/packages/cargo.en-us.md @@ -53,8 +53,6 @@ default = "gitea" index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index # index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git - - [net] git-fetch-with-cli = true ``` From e6c1b213747bc76e8ea74fe5203a82c0a2f713f4 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 12:05:22 +0200 Subject: [PATCH 4/6] added sparse url to package content template --- templates/package/content/cargo.tmpl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/templates/package/content/cargo.tmpl b/templates/package/content/cargo.tmpl index b7a34632e4a23..67e003c9d1a14 100644 --- a/templates/package/content/cargo.tmpl +++ b/templates/package/content/cargo.tmpl @@ -8,7 +8,8 @@ default = "gitea" [registries.gitea] -index = "" +index = "" # Sparse index +# index = "" # Git [net] git-fetch-with-cli = true From 3c00079f27eb1125f03f07767507c2fe1fff5227 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 12:08:06 +0000 Subject: [PATCH 5/6] Added comments regarding sparse index in docs --- docs/content/usage/packages/cargo.en-us.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/content/usage/packages/cargo.en-us.md b/docs/content/usage/packages/cargo.en-us.md index e0ae6c30de450..3cc695def4bce 100644 --- a/docs/content/usage/packages/cargo.en-us.md +++ b/docs/content/usage/packages/cargo.en-us.md @@ -53,8 +53,8 @@ default = "gitea" index = "sparse+https://gitea.example.com/api/packages/{owner}/cargo/" # Sparse index # index = "https://gitea.example.com/{owner}/_cargo-index.git" # Git -[net] -git-fetch-with-cli = true +# [net] +# git-fetch-with-cli = true ``` | Parameter | Description | @@ -73,6 +73,11 @@ token = "Bearer {token}" | --------- | ----------- | | `token` | Your [personal access token](development/api-usage.md#authentication) | +## Git vs Sparse +Currently, cargo supports two ways for fetching crates in a registry: Git index & sparse index. +Sparse index is the newest method and offers better performance when updating crates compared to git. +Since Rust 1.68, sparse is the default method for crates.io. + ## Publish a package Publish a package by running the following command in your project: From 4f48c5166928a3b23f332f27e70c28609f6537e8 Mon Sep 17 00:00:00 2001 From: merlleu Date: Wed, 6 Sep 2023 12:10:10 +0000 Subject: [PATCH 6/6] fix linter issue --- docs/content/usage/packages/cargo.en-us.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/content/usage/packages/cargo.en-us.md b/docs/content/usage/packages/cargo.en-us.md index 3cc695def4bce..356e7ff0b9bef 100644 --- a/docs/content/usage/packages/cargo.en-us.md +++ b/docs/content/usage/packages/cargo.en-us.md @@ -74,6 +74,7 @@ token = "Bearer {token}" | `token` | Your [personal access token](development/api-usage.md#authentication) | ## Git vs Sparse + Currently, cargo supports two ways for fetching crates in a registry: Git index & sparse index. Sparse index is the newest method and offers better performance when updating crates compared to git. Since Rust 1.68, sparse is the default method for crates.io.