Sugar Network/Recipe Specification: Difference between revisions

Line 42:

This is a required section (but see also [[#Presets|presets]]). It describes the main recipe component.

'''~~slug~~''' = <package~~-slug~~>

'''sweet''' = <obs-project>/<obs-package>

The ~~string~~ used ~~as identifier~~ in cases ~~like 0install~~ feed ~~urls or~~ native package names. ~~Only~~ lower alphabetic, numeric, "+" or "-" symbols ~~are allowed. Slug value~~ should be at least two characters long and start with an alphanumeric character.

The unique identifier of the package. Will be used in several use cases:

* fully qualified OBS package name on http://bazaar.sugarlabs.org (note that ''obs-project'' is colon separated project path),

* in 0isntall feed url in format [http://sweets.sugarlabs.org/ http://sweets.sugarlabs.org/''sweet''],

* the value of ''obs-package'' will be used as a part of native package names.

The value of ''obs-package'' should contain only lower alphabetic, numeric, "+" or "-" symbols and should be at least two characters long and start with an alphanumeric character.

'''branch''' = <obs-project>/<obs-package>

If current package is a different implementation of another one, ''branch'' should be used to point to the package on http://bazaar.sugarlabs.org. Note that ''sweet'' should still point to the original package.

'''name''' = <package-name>

Package name, in free form, equals to ''~~slug~~'', by default.

Package name, in free form, equals to ''obs-package'', by default.

'''summary''' = <one-line-description>

@@ Line 42: / Line 42: @@
 This is a required section (but see also [[#Presets|presets]]). It describes the main recipe component.
-  '''slug''' = <package-slug>
+  '''sweet''' = <obs-project>/<obs-package>
-The string used as identifier in cases like 0install feed urls or native package names. Only lower alphabetic, numeric, "+"  or "-" symbols are allowed. Slug value should be at least two characters long and start with an alphanumeric character.
+The unique identifier of the package. Will be used in several use cases:
+* fully qualified OBS package name on http://bazaar.sugarlabs.org (note that ''obs-project'' is colon separated project path),
+* in 0isntall feed url in format [http://sweets.sugarlabs.org/ http://sweets.sugarlabs.org/''sweet''],
+* the value of ''obs-package'' will be used as a part of native package names.
+The value of ''obs-package'' should contain only lower alphabetic, numeric, "+"  or "-" symbols and should be at least two characters long and start with an alphanumeric character.
+ '''branch''' = <obs-project>/<obs-package>
+If current package is a different implementation of another one, ''branch'' should be used to point to the package on http://bazaar.sugarlabs.org. Note that ''sweet'' should still point to the original package.
   '''name''' = <package-name>
-Package name, in free form, equals to ''slug'', by default.
+Package name, in free form, equals to ''obs-package'', by default.
   '''summary''' = <one-line-description>