external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
aurweb/doc/git-archive.md
moson-mo 137644e919
docs: suggest shallow clone in git-archive.md 
we should be suggesting to make a shallow clone to reduce
the amount of data that is being transferred initially

Signed-off-by: moson-mo <mo-son@mailbox.org>
2022-09-25 10:03:05 +02:00

2.2 KiB
Raw Blame History

aurweb Git Archive Specification

WARNING: This aurweb Git Archive implementation is experimental and may be changed.

Overview

This git archive specification refers to the archive git repositories created by aurweb/scripts/git_archive.py using spec modules.

Configuration

  • [git-archive]
    • author
      • Git commit author
    • author-email
      • Git commit author email

See an official spec's documentation for spec-specific configurations.

Fetch/Update Archives

When a client has not yet fetched any initial archives, they should shallow-clone the repository:

$ git clone --depth=1 https://aur.archlinux.org/archive.git aurweb-archive

When updating, the repository is already cloned and changes need to be pulled from remote:

# To update:
$ cd aurweb-archive && git pull

For end-user production applications, see Minimize Disk Space.

Minimize Disk Space

Using git gc on the repository will compress revisions and remove unreachable objects which grow the repository a considerable amount each commit. It is recommended that the following command is used after cloning the archive or pulling updates:

$ cd aurweb-archive && git gc --aggressive

Spec Modules

Each aurweb spec module belongs to the aurweb.archives.spec package. For example: a spec named "example" would be located at aurweb.archives.spec.example.

Official spec listings use the following format:

  • spec_name
    • Spec description; what this spec produces
      • <link to repo documentation>

Official Specs