Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 2.87 KB

patch.json.md

File metadata and controls

64 lines (50 loc) · 2.87 KB
Raw

Example patch.json

This describes the format of the patch.json.

This is automatically generated and added to your Patch distribution if you choose to upload your Patch to the Web Catalog. Hence you should NOT include one with your Patch if you do that.

If you distribute your Patch some other way, e.g. as an RPM package, you must provide a valid patch.json file.

{
    "author": "Jim Example",
    "name": "the-internal-patch-name",
    "display_name": "Human-facing Patch Name",
    "version": "1.0.0",
    "category": "calendar",
    "description": "This is a long description of what this Patch does.\nIt will be displayed in the Patch page.",
    "discussion": "https://example.org/forum/thead?id=9999",
    "sources": "https://git.example.org/patch.git",
    "donations": "https://example.org/donate",
    "compatible": [ "3.2.1.20", "3.3.0.14", "3.3.0.16" ],
    "id": NNN,
    "last_updated": "2020-04-28T06:56:21.931",
}

Description of options:

Required / Recommended:

  • display_name: The name of the Patch, which will be shown on the patch list.
  • version: A version string. It MUST be in the format X.Y.Z
  • author: The name of the principal Patch author or maintainer. Either use your real name, as displayed on Github or Twitter, or your usual nickname.
  • compatible: A list of SailfishOS releases the Patch works on. Versions MUST be given in full with all four fields populated, e.g. "3.3.0.16" (using just "3.3" is invalid).

Optional:

  • description: Explanation of what the Patch does.
  • category: This is used to structure the list of Patches in categories, but also certain categories will cause Patchmanager to restart affected system services or applications. For example, Patches in the category "homescreen" will prompt the user to restart Lipstick after their activation.
  • discussion, sources, donations: Optional links to websites.
  • last_updated": An ISO date string, the Web Catalog sets this. It is used for sorting and update detection.
  • name: An internal name for the Patch. As this is used as a directory name, it should only contain alphanumeric characters, underscores and hyphens. Notably NO spaces, dollar signs or other special characters should be used!

Reserved:

  • id: A numeric ID used by Web Catalog. This MUST NOT be included in Patches which are not distributed via Web Catalog.

List of supported categories:

Supplying a category not on this list will cause the Patch to be shown in the category "other".

  • "homescreen" - will restart Lipstick
  • "silica" - will restart Lipstick
  • "keyboard" - will restart the keyboard service

These will stop or restart the corresponding system applications (e.g. the jolla-browser) after activating the Patch.

  • "browser"
  • "calendar"
  • "camera"
  • "clock"
  • "contacts"
  • "email"
  • "gallery"
  • "media"
  • "messages"
  • "phone"
  • "settings"