This is an old revision of the document!
You can change how your repository is shown on git.kernel.org using a special __meta__ branch of each repository.
To create the special __meta__ branch, use the following commands:
git checkout --orphan __meta__ git rm -rf . # add any files you need, see below git push origin __meta__
You can now add a cgitrc
file to the __meta__ branch, for example:
owner=Tux Penguino desc=Frobble module development
Almost all repo.*
configuration parameters are supported (see allowlist below). For in-depth description of each option, see man cgitrc.
Full list of allowed options (make sure there are no spaces around =
):
# repository owner (e.g. your name) owner=Tux Penguino # repository description desc=Frobble module development # Link to the project home page homepage=https://frobblemod.io # Default branch to show, if it's not master defbranch=frobble # turn off .tar.gz snapshots for this repository snapshots=0 # hide the repository from the listing, but leave it accessible via direct link hide=1 # don't make this repository accessible via cgit (but make it still clonable) ignore=1
Note, that ignore=1
still allows that repository to be cloned via git:
if someone knows the full path to it.
or
https:
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.
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.
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.