DocSource


1 Usage[edit]

The DocSource template is used to indicate the URL of any Linux® kernel, Yocto Project, AWS IoT Greengrass, U-Boot, TF-A, and OP-TEE document used in this wiki.

Usage: {{DocSource | domain=<domain> | path=<path> | text=<link text> | version=<version>}}
Where:
  • <domain> is the mandatory string that identifies the domain of the document. The possible values are:
    • Linux kernel: the document belongs to the Linux kernel domain.
    • Yocto Project: the document belongs to the Yocto Project domain.
    • AWS Greengrass: the document belongs to the AWS IoT Greengrass domain.
    • U-Boot: the document belongs to U-Boot domain
    • TF-A: the document belongs to TF-A domain.
    • OP-TEE: the document belongs to OP-TEE domain.
  • <link text> is an optional link text (text that is displayed instead of the URL).




  • <version> is an optional version number (branch or tag) if the default one doesn't fit. Per default, the URL points to:
    • the 5.15 version branch of the Linux kernel
    • the 4.0 version branch of the Yocto Project TBC
    • the latest version branch of the AWS IoT Greengrass
    • the 2021.07 version branch of the U-Boot documentation
    • the 2.6 version branch of the TF-A documentation
    • the 3.16.0 version branch of the OP-TEE documentation

2 Basic examples[edit]

You type You get
Linux kernel
1- {{DocSource | domain=Linux kernel | path=crypto/index.html}}<br />
2- {{DocSource | domain=Linux kernel | path=gpu/drm-uapi.html}}

1- crypto/index.html
2- gpu/drm-uapi.html

Yocto Project
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs}}

1- overview-manual
2- brief-yoctoprojectqs

AWS IoT Greengrass
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br />
2- {{DocSource | domain=AWS Greengrass | path=developerguide/device-config-setup.html}}

1- developerguide/what-is-gg.html
2- developerguide/device-config-setup.html

U-Boot
1- {{DocSource | domain=U-Boot | path=index.html}}<br />
2- {{DocSource | domain=U-Boot | path=build/index.html}}

1- index.html
2- build/index.html

TF-A
1- {{DocSource | domain=TF-A | path=index.html}}<br />
2- {{DocSource | domain=TF-A | path=getting_started/index.html}}

1- index.html
2- getting_started/index.html

OP-TEE_OS
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br />
2- {{DocSource | domain=OP-TEE| path=index.html}}

1- general/index.html
2- index.html

3 More examples[edit]

You type You get
Linux kernel
1- {{DocSource | domain=Linux kernel | path=crypto/index.html}}<br />
2- {{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API}}<br />
3- {{DocSource | domain=Linux kernel | path=crypto/index.html | version=4.19}}<br />
4- {{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API | version=4.19}}

1- crypto/index.html
2- Linux Kernel Crypto API
3- crypto/index.html (v4.19)
4- Linux Kernel Crypto API (v4.19)

Yocto Project
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=overview-manual | text=Yocto Project Overview and Concepts Manual}}<br />
3- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | version=3.0}}<br />
4- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts Manual | version=3.0}}

1- overview-manual
2- Yocto Project Overview and Concepts Manual
3- overview-manual/overview-manual.html (v3.0)
4- Yocto Project Overview and Concepts Manual (v3.0)

AWS IoT Greengrass
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br />
2- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass?}}<br />
3- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | version=2}}<br />
4- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass? | version=2}}

1- developerguide/what-is-gg.html
2- What is AWS IoT Greengrass?
3- developerguide/what-is-gg.html (v2)
4- What is AWS IoT Greengrass? (v2)

U-Boot
1- {{DocSource | domain=U-Boot | path=build/index.html}}<br />
2- {{DocSource | domain=U-Boot | path=build/index.html | text=How to build U-Boot?}}<br />
3- {{DocSource | domain=U-Boot | path=build/index.html | version=2021.01}}<br />
4- {{DocSource | domain=U-Boot | path=build/index.html | text=How to build U-Boot? | version=2021.01}}

1- build/index.html
2- How to build U-Boot?
3- build/index.html (v2021.01)
4- How to build U-Boot? (v2021.01)

TF-A
1- {{DocSource | domain=TF-A| path=getting_started/docs-build.html}}<br />
2- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| text=Building Documentation}}<br />
3- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| version=2.5}}<br />
4- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| text=Building Documentation| version=2.5}}

1- getting_started/docs-build.html
2- Building Documentation
3- getting_started/docs-build.html (v2.5)
4- Building Documentation (v2.5)

OP-TEE
1- {{DocSource | domain=OP-TEE| path=architecture/index.html}}<br />
2- {{DocSource | domain=OP-TEE|  path=architecture/index.html | text=Architecture}}<br />
3- {{DocSource | domain=OP-TEE| path=architecture/index.html| version=3.14.0}}<br />
4- {{DocSource | domain=OP-TEE| path=architecture/index.html | text=Architecture | version=3.14.0}}

1- architecture/index.html
2- Architecture
3- architecture/index.html (3.14.0)
4- Architecture (3.14.0)

Check that there's no space before and after the text
1- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html}}AFTER<br />
2- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API}}AFTER<br />
3- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | version=4.19}}AFTER<br />
4- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API | version=4.19}}AFTER

1- BEFOREcrypto/index.htmlAFTER
2- BEFORELinux Kernel Crypto APIAFTER
3- BEFOREcrypto/index.html (v4.19)AFTER
4- BEFORELinux Kernel Crypto API (v4.19)AFTER

Unsupported domain
{{DocSource | domain=Unsupported domain | path=Document}}

Unsupported domain!

4 Code[edit]

Linux kernel: [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v5.15}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]

Yocto Project: [https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]

AWS IoT Greengrass [https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]

U-Boot: [https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2021.07}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]

TF-A: [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.6}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]

OP-TEES: [https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.16.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| ({{#replace:{{{version|}}}| |}})}}]


Unsupported domain!