1
1
mirror of https://github.com/go-gitea/gitea synced 2024-07-04 09:05:48 +00:00
gitea/docs/content/doc/usage/clone-filter.en-us.md
Lunny Xiao e8433b7fe6
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629)
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.

After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions

---------

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-03-23 23:18:24 +08:00

1.4 KiB

date title slug weight draft toc menu
2021-02-02 Clone filters (partial clone) clone-filters 25 false false
sidebar
parent name weight identifier
usage Clone filters 25 clone-filters

Clone filters (partial clone)

Git introduces --filter option to git clone command, which filters out large files and objects (such as blobs) to create partial clone of a repo. Clone filters are especially useful for large repo and/or metered connection, where full clone (without --filter) can be expensive (as all history data must be downloaded).

This requires Git version 2.22 or later, both on the Gitea server and on the client. For clone filters to work properly, make sure that Git version on the client is at least the same as on the server (or later). Login to Gitea server as admin and head to Site Administration -> Configuration to see Git version of the server.

By default, clone filters are enabled, unless DISABLE_PARTIAL_CLONE under [git] is set to true.

See GitHub blog post: Get up to speed with partial clone for common use cases of clone filters (blobless and treeless clones), and GitLab docs for partial clone for more advanced use cases (such as filter by file size and remove filters to turn partial clone into full clone).