This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
userdoc:cgit-meta-data [2018-04-02 18:55] mricon |
userdoc:cgit-meta-data [2020-05-08 14:02] mricon |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ~~REDIRECT>https://korg.docs.kernel.org/cgit-meta-data.html~~ | ||
+ | |||
====== Repo appearance on git.kernel.org ====== | ====== Repo appearance on git.kernel.org ====== | ||
- | You can change how your repository is shown on git.kernel.org using a special %%__meta__%% branch of each repository. | + | You can change how your repository is shown on git.kernel.org using a special ''refs/meta/cgit'' ref in each repository. |
+ | |||
+ | ===== Creating the special ref ===== | ||
+ | |||
+ | To create the special ''refs/meta/cgit'' ref, use the following commands: | ||
+ | |||
+ | <code> | ||
+ | git symbolic-ref HEAD refs/meta/cgit | ||
+ | git reset --hard | ||
+ | # add and commit any files you need, see below | ||
+ | git push origin HEAD:refs/meta/cgit | ||
+ | git checkout master | ||
+ | </code> | ||
- | ===== Creating the __meta__ branch ===== | + | ===== Editing files in the special ref ===== |
- | To create the special %%__meta__%% branch, use the following commands: | + | It is a bit trickier to edit files in the special ref as opposed to a normal branch. |
<code> | <code> | ||
- | git checkout --orphan __meta__ | + | git fetch origin refs/meta/cgit |
- | git rm -rf . | + | git checkout FETCH_HEAD |
- | # add any files you need, see below | + | # make any changes and commit them |
- | git push origin __meta__ | + | git push origin HEAD:refs/meta/cgit |
+ | git checkout master | ||
</code> | </code> | ||
===== Cgit configuration options ===== | ===== Cgit configuration options ===== | ||
- | You can now add a ''cgitrc'' file to the %%__meta__%% branch, for example: | + | You can add a ''cgitrc'' file to the ''refs/meta/cgit'' location, for example: |
<file> | <file> | ||
Line 32: | Line 47: | ||
# repository description | # repository description | ||
desc=Frobble module development | desc=Frobble module development | ||
+ | # generate tarballs with this prefix instead of repo name | ||
+ | # e.g. instead of linux-stable-x.x.x.tar.gz, do linux-x.x.x.tar.gz | ||
+ | snapshot-prefix=linux | ||
# Link to the project home page | # Link to the project home page | ||
homepage=https://frobblemod.io | homepage=https://frobblemod.io | ||
Line 48: | Line 66: | ||
===== Repo-specific about tab ===== | ===== Repo-specific about tab ===== | ||
- | Your repository is probably going to be a clone of linux.git, so if you want to display different info in the "about" tab of the repo instead of the default linux README, you can add a separate README file in the %%__meta__%% branch. | + | Your repository is probably going to be a clone of linux.git, so if you want to display different info in the "about" tab of the repo instead of the default linux README, you can add a separate README file in the ''refs/meta/cgit'' location. |
We will look for README, README.md and README.rst files, so if you want Markdown or ReST formatting in the about tab, you can use the appropriate file extension. | We will look for README, README.md and README.rst files, so if you want Markdown or ReST formatting in the about tab, you can use the appropriate file extension. | ||
Line 54: | Line 72: | ||
===== Note on caching ===== | ===== Note on caching ===== | ||
- | CGit heavily relies on caching, so it can take up to a few hours for the changes you made to the %%__meta__%% branch to show up on git.kernel.org. | + | CGit heavily relies on caching, so it can take up to a few hours for the changes you made to the ''refs/meta/cgit'' ref to show up on git.kernel.org. |