Sugar Network/Recipe Specification - Revision history

Alsroot: /* Dependencies */

2013-07-03T23:00:41Z

Dependencies

← Older revision		Revision as of 19:00, 3 July 2013
Line 307:		Line 307:
	''DEPENDENCY'' [(<\|<=\|=\|>=\|>) ''VERSION'']		''DEPENDENCY'' [(<\|<=\|=\|>=\|>) ''VERSION'']

	The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context] ~~GUID~~, but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].		The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context], but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].

	== Glob patterns ==		== Glob patterns ==

Alsroot: /* Glob patterns */

2013-07-02T04:16:29Z

Glob patterns

← Older revision		Revision as of 00:16, 2 July 2013
Line 309:		Line 309:
	The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context] GUID, but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].		The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context] GUID, but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].

	=== Glob patterns ===		== Glob patterns ==

	The ''include'' and ''exclude'' options contain file patterns. A pattern could be of two types:		The ''include'' and ''exclude'' options contain file patterns. A pattern could be of two types:

Alsroot: /* Dependencies */

2013-07-02T04:16:15Z

Dependencies

← Older revision		Revision as of 00:16, 2 July 2013
Line 308:		Line 308:

	The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context] GUID, but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].		The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context] GUID, but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].

			=== Glob patterns ===

			The ''include'' and ''exclude'' options contain file patterns. A pattern could be of two types:

			* doesn't contain ''/'' or ''**'' substrings, will be applied only to file names
			* contains ''/'' or ''**'' substring, will be applied to the full file path (relative to the root), thus could affect several directory levels

			Only these pattern symbols are allowed:

			* ''*'' matches everything, except directory separator
			* ''?'' matches any single character, except directory separator
			* ''**'' matches everything, including directory separator

Alsroot at 04:13, 2 July 2013

2013-07-02T04:13:49Z

← Older revision		Revision as of 00:13, 2 July 2013
Line 1:		Line 1:
			== Summary ==

	The document describes software specification files format which is a superset on top of the Sugar [[Development_Team/Almanac/Activity_Bundles\|activity bundles]] specification. This format is backwards compatible with [[Development_Team/Almanac/Activity_Bundles#.info_file_format\|activity.info]] files to make sure that software starts well from the regular Sugar Shell. But the major purpose of introducing new format is supporting software hosted on the [[Sugar Network]]. In particular, new format assumes the following functionality:		The document describes software specification files format which is a superset on top of the Sugar [[Development_Team/Almanac/Activity_Bundles\|activity bundles]] specification. This format is backwards compatible with [[Development_Team/Almanac/Activity_Bundles#.info_file_format\|activity.info]] files to make sure that software starts well from the regular Sugar Shell. But the major purpose of introducing new format is supporting software hosted on the [[Sugar Network]]. In particular, new format assumes the following functionality:

Alsroot at 04:13, 2 July 2013

2013-07-02T04:13:04Z

Show changes

Alsroot: Alsroot moved page Platform Team/Recipe Specification to Sugar Network/Recipe Specification

2013-07-02T01:25:43Z

Alsroot moved page Platform Team/Recipe Specification to Sugar Network/Recipe Specification

← Older revision	Revision as of 21:25, 1 July 2013
(No difference)

Alsroot: /* Archive sections */

2011-10-29T16:00:57Z

Archive sections

← Older revision		Revision as of 12:00, 29 October 2011
Line 184:		Line 184:

	Optional. Like the ''include'' option, but used for excluding files from the archive. In addition, various temporary files will be excluded, like ''.bak'' or ''.pyc''.		Optional. Like the ''include'' option, but used for excluding files from the archive. In addition, various temporary files will be excluded, like ''.bak'' or ''.pyc''.
			<!-- Not yet implemented
	'''langs''' = <lang-name> [; ...]		'''langs''' = <lang-name> [; ...]
	include[<lang-name>] = <glob-pattern> [; ...]		include[<lang-name>] = <glob-pattern> [; ...]
	exclude[<lang-name>] = <glob-pattern> [; ...]		exclude[<lang-name>] = <glob-pattern> [; ...]

	Optional. A special form of ''include''/''exclude'' options that are intended to create separate, per locale, archives. If a language is mentioned in the ''langs'' list, but doesn't have any ''include[]''/''exclude[]'' options, ''include''/''exclude'' will be used (in that case, using the special [[#Predefined_options\|LANG]] variable makes sense).		Optional. A special form of ''include''/''exclude'' options that are intended to create separate, per locale, archives. If a language is mentioned in the ''langs'' list, but doesn't have any ''include[]''/''exclude[]'' options, ''include''/''exclude'' will be used (in that case, using the special [[#Predefined_options\|LANG]] variable makes sense).-->

	'''arch''' = <arch>		'''arch''' = <arch>

Alsroot: /* Common options */

2011-10-29T15:57:11Z

Common options

← Older revision		Revision as of 11:57, 29 October 2011
Line 74:		Line 74:
	'''suggests''' = <dependency> [; ...]		'''suggests''' = <dependency> [; ...]

	Optional. List of [[Platform_Team/Guide/Sweets_Packaging#\|~~Dependenciesdependencies~~]] that will be demanded to be present at run-time only if it was explicitly required from a user.		Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Dependencies\|dependencies]] that will be demanded to be present at run-time only if it was explicitly required from a user.

	=== [Activity] ===		=== [Activity] ===

Alsroot at 15:56, 29 October 2011

2011-10-29T15:56:23Z

← Older revision		Revision as of 11:56, 29 October 2011
Line 67:		Line 67:
	* testing		* testing
	* stable		* stable

			'''requires''' = <dependency> [; ...]

			Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Dependencies\|dependencies]] that should exist at run-time before launching the sweet.

			'''suggests''' = <dependency> [; ...]

			Optional. List of [[Platform_Team/Guide/Sweets_Packaging#\|Dependenciesdependencies]] that will be demanded to be present at run-time only if it was explicitly required from a user.

	=== [Activity] ===		=== [Activity] ===
Line 91:		Line 99:

	Optional. List of mime types supported by the activity. It's used when opening a file from the web, or to present to the user a list of activities that can open a certain Journal object.		Optional. List of mime types supported by the activity. It's used when opening a file from the web, or to present to the user a list of activities that can open a certain Journal object.

	~~'''requires''' = <dependency> [(=\|>=\|<) <version>] [; ...]~~

	~~Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Interfaces\|dependencies]] that should exist at run-time before launching the activity.~~

	=== [Application] ===		=== [Application] ===
Line 103:		Line 107:

	Required. The relative path of an executable command inside the implementation that should be executed by default when the sweet is run. Command can have optional arguments.		Required. The relative path of an executable command inside the implementation that should be executed by default when the sweet is run. Command can have optional arguments.

	~~'''requires''' = <dependency> [(=\|>=\|<) <version>] [; ...]~~

	~~Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Interfaces\|dependencies]] that should exist at run-time before launching the application.~~

	=== [Library] ===		=== [Library] ===
Line 113:		Line 113:

	Required. The environment variables 0install should export to the process that uses this sweet.		Required. The environment variables 0install should export to the process that uses this sweet.

	~~'''requires''' = <dependency> [(=\|>=\|<) <version>] [; ...]~~

	~~Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Interfaces\|dependencies]] the library is based on.~~

	=== [Package] ===		=== [Package] ===
Line 148:		Line 144:

	Required. The filename with sources bundle.		Required. The filename with sources bundle.

	~~'''requires''' = <dependency> [(=\|>=\|<) <version>] [; ...]~~

	~~Optional. List of [[Platform_Team/Guide/Sweets_Packaging#Interfaces\|dependencies]] the package is based on.~~

	'''patches''' = <patch-filename> [patch-level] [; ...]		'''patches''' = <patch-filename> [patch-level] [; ...]
Line 215:		Line 207:
	'''NOTE''' The commands in this section will be executed, not only in the developer's environment, but also in the user's, if a proper binary wasn't found; so move all development-related commands, like {{Code\|autogen.sh}}, to the ''[Source]'' section.		'''NOTE''' The commands in this section will be executed, not only in the developer's environment, but also in the user's, if a proper binary wasn't found; so move all development-related commands, like {{Code\|autogen.sh}}, to the ''[Source]'' section.

	'''requires''' = <dependency~~-name~~> ~~[(=\|>=\|<) <version>]~~ [; ...]		'''requires''' = <dependency> [; ...]

	Optional. This defines what [[Platform_Team/Guide/Sweets_Packaging#~~Interfaces~~\|dependencies]] should be present before building the sweet from sources. Note that ''requires'' from [[#.5BComponent.5D\|[Component]]] sections are not auto included in the build-time dependencies.		Optional. This defines what [[Platform_Team/Guide/Sweets_Packaging#Dependencies\|dependencies]] should be present before building the sweet from sources. Note that ''requires'' from [[#.5BComponent.5D\|[Component]]] sections are not auto included in the build-time dependencies.

	'''clean''' = <shell-command>		'''clean''' = <shell-command>
Line 246:		Line 238:
	Optional. If the ''exec'' option was not used, all files will be bundled and these [[Platform_Team/Guide/Sweets_Packaging#Glob_patterns\|glob patterns]] might be used to reify the selection.		Optional. If the ''exec'' option was not used, all files will be bundled and these [[Platform_Team/Guide/Sweets_Packaging#Glob_patterns\|glob patterns]] might be used to reify the selection.

	'''requires''' = <dependency> ~~[(=\|>=\|<) <version>]~~ [; ...]		'''requires''' = <dependency> [; ...]

	Optional. The dependencies that should be present before creating sources tarball. For example, if the ''exec'' command generates .c files from .vala, the vala dependency should be mentioned in the ''requires'' option.		Optional. The [[Platform_Team/Guide/Sweets_Packaging#Dependencies\|dependencies]] that should be present before creating sources tarball. For example, if the ''exec'' command generates .c files from .vala, the vala dependency should be mentioned in the ''requires'' option.

	== Predefined options ==		== Predefined options ==

Alsroot: /* [Package] */

2011-10-09T23:27:50Z

[Package]

← Older revision		Revision as of 19:27, 9 October 2011
Line 129:		Line 129:
	In addition to the already [[#Predefined_options\|existing]] predefined options, there are several new defines that make sense only for this section's packages:		In addition to the already [[#Predefined_options\|existing]] predefined options, there are several new defines that make sense only for this section's packages:

	* {{Code\|EXEC_PREFIX}}		* {{Code\|EXEC_PREFIX}};
	* {{Code\|BINDIR}}		* {{Code\|BINDIR}};
	* {{Code\|SBINDIR}}		* {{Code\|SBINDIR}};
	* {{Code\|SYSCONFDIR}}		* {{Code\|SYSCONFDIR}};
	* {{Code\|DATADIR}}		* {{Code\|DATADIR}};
	* {{Code\|INCLUDEDIR}}		* {{Code\|INCLUDEDIR}};
	* {{Code\|LIBDIR}}		* {{Code\|LIBDIR}};
	* {{Code\|LIBEXECDIR}}		* {{Code\|LIBEXECDIR}};
	* {{Code\|LOCALSTATEDIR}}		* {{Code\|LOCALSTATEDIR}};
	* {{Code\|MANDIR}}		* {{Code\|MANDIR}};
	* {{Code\|INFODIR}}		* {{Code\|INFODIR}};
	* {{Code\|PYTHONSITEDIR}}		* {{Code\|PYTHONSITEDIR}}, equal to Python's {{Code\|PYTHONPATH}} environment variable;
			* {{Code\|LUACPATHDIR}}, equal to Lua's {{Code\|LUA_CPATH}} environment variable;
			* {{Code\|LUAPATHDIR}}, equal to Lua's {{Code\|LUA_PATH}} environment variable;
			* {{Code\|LUAINCDIR}}, path to a directory with Lua's C header file;

	'''source''' = <filename>		'''source''' = <filename>

← Older revision		Revision as of 19:27, 9 October 2011
Line 129:		Line 129:
	In addition to the already [[#Predefined_options\|existing]] predefined options, there are several new defines that make sense only for this section's packages:		In addition to the already [[#Predefined_options\|existing]] predefined options, there are several new defines that make sense only for this section's packages:

	* {{Code\|EXEC_PREFIX}}		* {{Code\|EXEC_PREFIX}};
	* {{Code\|BINDIR}}		* {{Code\|BINDIR}};
	* {{Code\|SBINDIR}}		* {{Code\|SBINDIR}};
	* {{Code\|SYSCONFDIR}}		* {{Code\|SYSCONFDIR}};
	* {{Code\|DATADIR}}		* {{Code\|DATADIR}};
	* {{Code\|INCLUDEDIR}}		* {{Code\|INCLUDEDIR}};
	* {{Code\|LIBDIR}}		* {{Code\|LIBDIR}};
	* {{Code\|LIBEXECDIR}}		* {{Code\|LIBEXECDIR}};
	* {{Code\|LOCALSTATEDIR}}		* {{Code\|LOCALSTATEDIR}};
	* {{Code\|MANDIR}}		* {{Code\|MANDIR}};
	* {{Code\|INFODIR}}		* {{Code\|INFODIR}};
	* {{Code\|PYTHONSITEDIR}}		* {{Code\|PYTHONSITEDIR}}, equal to Python's {{Code\|PYTHONPATH}} environment variable;
			* {{Code\|LUACPATHDIR}}, equal to Lua's {{Code\|LUA_CPATH}} environment variable;
			* {{Code\|LUAPATHDIR}}, equal to Lua's {{Code\|LUA_PATH}} environment variable;
			* {{Code\|LUAINCDIR}}, path to a directory with Lua's C header file;

	'''source''' = <filename>		'''source''' = <filename>