Documentation Decoder - Revision history

Michael Opdenacker: /* List of Manual Pages */ Update documentation URLs

2021-07-30T14:38:34Z

List of Manual Pages: Update documentation URLs

← Older revision		Revision as of 14:38, 30 July 2021
Line 17:		Line 17:
	Here is a list of documentation page names and brief descriptions of their purposes.		Here is a list of documentation page names and brief descriptions of their purposes.
	This list represents the latest Yocto Project release:		This list represents the latest Yocto Project release:
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/brief-yoctoprojectqs/~~brief-yoctoprojectqs.html~~ brief-yoctoprojectqs]. A very brief quick start to get you going.		:[https://docs.yoctoproject.org/current/brief-yoctoprojectqs/ brief-yoctoprojectqs]. A very brief quick start to get you going.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/overview-manual/~~overview-manual.html~~ overview-manual]. Presents Yocto Project overview and conceptual information.		:[https://docs.yoctoproject.org/current/overview-manual/ overview-manual]. Presents Yocto Project overview and conceptual information.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/dev-manual/~~dev-manual.html~~ dev-manual]. A development tasks manual. Provides procedures for common and not-so-common development tasks.		:[https://docs.yoctoproject.org/current/dev-manual/ dev-manual]. A development tasks manual. Provides procedures for common and not-so-common development tasks.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/sdk-manual/~~sdk-manual.html~~ sdk-manual]. Describes how to build and use Yocto Project SDKs for application development.		:[https://docs.yoctoproject.org/current/sdk-manual/ sdk-manual]. Describes how to build and use Yocto Project SDKs for application development.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/bsp-guide/~~bsp-guide.html~~ bsp-guide]. Describes how to use or create a Board Support Package (BSP)layer for your hardware platform.		:[https://docs.yoctoproject.org/current/bsp-guide/ bsp-guide]. Describes how to use or create a Board Support Package (BSP)layer for your hardware platform.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/kernel-dev/~~kernel-dev.html~~ kernel-dev]. The kernel development manual, which is often used in conjunction with BSP guide.		:[https://docs.yoctoproject.org/current/kernel-dev/ kernel-dev]. The kernel development manual, which is often used in conjunction with BSP guide.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/profile-manual/~~profile-manual.html~~ profile-manual] Presents information on profiling and tracing.		:[https://docs.yoctoproject.org/current/profile-manual/ profile-manual] Presents information on profiling and tracing.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/toaster-manual/~~toaster-manual.html~~ toaster-manual]. Describes how to use "Toaster". which is a web interface to the Yocto Project's OpenEmbedded build system.		:[https://docs.yoctoproject.org/current/toaster-manual/ toaster-manual]. Describes how to use "Toaster". which is a web interface to the Yocto Project's OpenEmbedded build system.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/ref-manual/~~ref-manual~~.html ref-manual]. Gathers together Yocto Project reference material, which consists of variable descriptions, class descriptions, and so forth.		:[https://docs.yoctoproject.org/current/ref-manual/index.html ref-manual]. Gathers together Yocto Project reference material, which consists of variable descriptions, class descriptions, and so forth.
	:[~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/~~mega-manual/mega-manual~~.html mega-manual]. All of the above rolled into one "mega manual". You can use this manual to quickly search for terms and stings throughout the Yocto Project manual set.		:[https://docs.yoctoproject.org/current/singleindex.html mega-manual]. All of the above rolled into one "mega manual". You can use this manual to quickly search for terms and stings throughout the Yocto Project manual set.

Michael Opdenacker: /* URL Decoder */ Update documentation URLS

2021-07-30T14:32:10Z

URL Decoder: Update documentation URLS

← Older revision		Revision as of 14:32, 30 July 2021
Line 4:		Line 4:
	Searches many times return very old versions of a manual.		Searches many times return very old versions of a manual.

	URLs use the following format: <tt>~~http~~://~~www~~.yoctoproject.org~~/docs~~/release/name/name~~.html~~</tt>.		URLs use the following format: <tt>https://docs.yoctoproject.org/release/name/name</tt>.
	With this format, the "release" string specifies the Yocto Project release associated with the manual.		With this format, the "release" string specifies the Yocto Project release associated with the manual.
	The "name" string represents the manual's folder name.		The "name" string represents the manual's folder name.
	You can find the list of the current folder strings in the next section.		You can find the list of the current folder strings in the next section.

	Here is an example for the "Yocto Project Reference Manual" for release 2.4: <tt>~~http~~://~~www~~.yoctoproject.org/~~docs/2~~.4/ref-manual/~~ref-manual.html~~</tt>		Here is an example for the "Yocto Project Reference Manual" for release 3.3: <tt>https://docs.yoctoproject.org/3.3/ref-manual/</tt>

	You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.~~5.1~~) to go to the latest released version of a manual.		You can use the string <tt>current</tt> rather than a specific release number (e.g. 3.3) to go to the latest released version of a manual.
	For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>~~http~~://~~www~~.yoctoproject.org~~/docs~~/current/dev-manual/~~dev-manual.html~~</tt> URL.<br/>		For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>https://docs.yoctoproject.org/current/dev-manual/</tt> URL.<br/>

	== List of Manual Pages ==		== List of Manual Pages ==

Scottrif: /* URL Decoder */

2018-10-30T16:16:02Z

URL Decoder

← Older revision		Revision as of 16:16, 30 October 2018
Line 9:		Line 9:
	You can find the list of the current folder strings in the next section.		You can find the list of the current folder strings in the next section.

	Here is an example for the "Yocto Project Reference Manual" for release 2.~~5.1~~: <tt>http://www.yoctoproject.org/docs/2.~~5.1~~/ref-manual/ref-manual.html</tt>		Here is an example for the "Yocto Project Reference Manual" for release 2.4: <tt>http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html</tt>

	You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.		You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.

Scottrif: /* URL Decoder */

2018-10-30T16:15:38Z

URL Decoder

← Older revision		Revision as of 16:15, 30 October 2018
Line 5:		Line 5:

	URLs use the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.		URLs use the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.
	With this format, the "release" specifies the Yocto Project release associated with the manual.		With this format, the "release" string specifies the Yocto Project release associated with the manual.
	The "name" string represents the manual's folder name.		The "name" string represents the manual's folder name.
	You can find the list of the current folder strings in the next section.		You can find the list of the current folder strings in the next section.

Scottrif: /* URL Decoder */

2018-10-30T16:15:18Z

URL Decoder

← Older revision		Revision as of 16:15, 30 October 2018
Line 4:		Line 4:
	Searches many times return very old versions of a manual.		Searches many times return very old versions of a manual.

	URLs use the following format: http://www.yoctoproject.org/docs/<release>/<name>/<name>.html.		URLs use the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.
	With this format, the "release" specifies the Yocto Project release associated with the manual.		With this format, the "release" specifies the Yocto Project release associated with the manual.
	The "name" string represents the manual's folder name.		The "name" string represents the manual's folder name.

Scottrif: /* URL Decoder */

2018-10-30T16:14:23Z

URL Decoder

← Older revision		Revision as of 16:14, 30 October 2018
Line 4:		Line 4:
	Searches many times return very old versions of a manual.		Searches many times return very old versions of a manual.

	URLs use the following format: ~~<tt>~~http://www.yoctoproject.org/docs/<release>/<name>/<name>.html~~</tt>~~.		URLs use the following format: http://www.yoctoproject.org/docs/<release>/<name>/<name>.html.
	With this format, the "release" specifies the Yocto Project release associated with the manual.		With this format, the "release" specifies the Yocto Project release associated with the manual.
	The "name" string represents the manual's folder name.		The "name" string represents the manual's folder name.

Scottrif: /* URL Decoder */

2018-10-30T16:13:52Z

URL Decoder

← Older revision		Revision as of 16:13, 30 October 2018
Line 4:		Line 4:
	Searches many times return very old versions of a manual.		Searches many times return very old versions of a manual.

	URLs use the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.		URLs use the following format: <tt>http://www.yoctoproject.org/docs/<release>/<name>/<name>.html</tt>.
	With this format, the "release" specifies the Yocto Project release associated with the manual.		With this format, the "release" specifies the Yocto Project release associated with the manual.
	The "name" string represents the manual's folder name.		The "name" string represents the manual's folder name.

Scottrif: /* URL Decoder */

2018-10-30T16:12:54Z

URL Decoder

← Older revision		Revision as of 16:12, 30 October 2018
Line 4:		Line 4:
	Searches many times return very old versions of a manual.		Searches many times return very old versions of a manual.

	:URLs ~~have~~ the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.		URLs use the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.
	: Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>		With this format, the "release" specifies the Yocto Project release associated with the manual.
			The "name" string represents the manual's folder name.
			You can find the list of the current folder strings in the next section.

			Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>

	You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.		You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.
	For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html</tt> URL.<br/>		For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html</tt> URL.<br/>

Scottrif: /* URL Decoder */

2018-10-30T16:10:20Z

URL Decoder

← Older revision		Revision as of 16:10, 30 October 2018
Line 1:		Line 1:
	== URL Decoder ==		== URL Decoder ==
	Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what.		Many different Yocto Project documentation pages are returned by Google searches and it can be hard to know what's what.
			You should be sure that an URL returned by a search engine represents the actual version of the manual in which you are interested.
			Searches many times return very old versions of a manual.

	:URLs have the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.		:URLs have the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.
	: Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>		: Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>

Scottrif: /* URL Decoder */

2018-10-30T16:08:47Z

URL Decoder

← Older revision		Revision as of 16:08, 30 October 2018
Line 3:		Line 3:
	:URLs have the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.		:URLs have the following format: <tt>http://www.yoctoproject.org/docs/release/name/name.html</tt>.
	: Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>		: Here is an example for the "Yocto Project Reference Manual" for release 2.5.1: <tt>http://www.yoctoproject.org/docs/2.5.1/ref-manual/ref-manual.html</tt>
	You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.<br/>		You can use the string <tt>current</tt> rather than a specific release number (e.g. 2.5.1) to go to the latest released version of a manual.
			For example, to access the latest Yocto Project Development Tasks Manual, use the <tt>http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html</tt> URL.<br/>

	== List of Manual Pages ==		== List of Manual Pages ==