Template:Overlay

[edit] 

Documentation

Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

Use this template to autofill information for adding a Gentoo overlay.

Parameters

To generate instructions for installing a Gentoo overlay

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Overlay name	1	Overlay name in the form that will show up in eselect repository list Example gentoo	String	required
Sync URI	uri	Sync URI to use for the respective overlay Example https://github.com/gentoo-mirror/gentoo.git	String	optional
Sync type	type	Sync type to use for the respective overlay Example git	String	optional

Usage

{{Overlay|name}}
{{Overlay|name|uri=https://example.com/overlay.git|type=git}}

See the template's testcases:

Test cases

Correct

One anonymous parameter matching an overlay already known to eselect-repository

Wiki code

{{Overlay|gentoo}}

Main version

To add the gentoo overlay, run:

root #eselect repository enable gentoo

root #emaint sync -r gentoo

Sandbox version

To add the gentoo overlay, run:

root #eselect repository enable gentoo

root #emaint sync -r gentoo

Adding an overlay unknown to eselect-repository

Wiki code

{{Overlay|gentoo|uri=https://github.com/gentoo/gentoo.git|type=git}}

Main version

To add the gentoo overlay, run:

root #eselect repository add gentoo git https://github.com/gentoo/gentoo.git

root #emaint sync -r gentoo

Sandbox version

To add the gentoo overlay, run:

root #eselect repository add gentoo git https://github.com/gentoo/gentoo.git

root #emaint sync -r gentoo

Incorrect

Adding an overlay unknown to eselect-repository while missing a URI parameter

Wiki code

{{Overlay|gentoo|type=git}}

Main version

To add the gentoo overlay, run:

root #eselect repository add gentoo git

root #emaint sync -r gentoo

Sandbox version

To add the gentoo overlay, run:

root #eselect repository add gentoo git

root #emaint sync -r gentoo

Adding an overlay unknown to eselect-repository while missing a type parameter

Wiki code

{{Overlay|gentoo|type=git}}

Main version

To add the gentoo overlay, run:

root #eselect repository add gentoo git

root #emaint sync -r gentoo

Sandbox version

To add the gentoo overlay, run:

root #eselect repository add gentoo git

root #emaint sync -r gentoo

Adding an overlay while missing the 1 parameter

Wiki code

{{Overlay|type=git}}

Main version

{{Overlay template error}}

Parameter 1 not defined. For correct usage see Overlay template's documentation on the 1 parameter.

Sandbox version

{{Overlay template error}}

Parameter 1 not defined. For correct usage see Overlay template's documentation on the 1 parameter.

Note
The above documentation is transcluded from Template:Overlay/doc. (edit | history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Please add categories and interwikis to the /doc subpage. (See the subpages of this template.)