Skip to content
Snippets Groups Projects
Verified Commit 39605f73 authored by David Runge's avatar David Runge :chipmunk:
Browse files

docs: Adapt documentation to changes in pacman 6.1


Add all new schema versions to documentation and outline what has
changed from the last version.

Signed-off-by: default avatarDavid Runge <dvzrv@archlinux.org>
parent 4dbebd9c
No related branches found
No related tags found
1 merge request!161Add documentation and changelog for 0.3.1
......@@ -31,6 +31,16 @@ PackageV1
.. literalinclude:: ../schema/PackageV1.json
:language: json
.. _packagev2:
PackageV2
^^^^^^^^^
This version removes the ``md5sum`` field as the hash algorithm is unsafe.
.. literalinclude:: ../schema/PackageV2.json
:language: json
.. _mtree:
.MTREE
......
......@@ -152,6 +152,18 @@ OutputPackageV1
.. literalinclude:: ../schema/OutputPackageV1.json
:language: json
.. _outputpackagev2_schema:
OutputPackageV2
"""""""""""""""
This version removes the ``md5sum`` field as the hash algorithm is unsafe and
renders the ``pgpsig`` field optional to lower the size of the created
:ref:`sync database` files.
.. literalinclude:: ../schema/OutputPackageV2.json
:language: json
.. _packagedesc_schema:
PackageDesc
......@@ -179,7 +191,8 @@ PackageDescV1
PackageDescV2
"""""""""""""
This version removes the ``pgpsig`` field to lower the size of the created
This version removes the ``md5sum`` field as the hash algorithm is unsafe and
renders the ``pgpsig`` field optional to lower the size of the created
:ref:`sync database` files.
.. note::
......
......@@ -111,7 +111,7 @@ Desc v1
extend a package's functionality (one name per line below the identifier)
* ``%PACKAGER%`` (**required**): The UID (name and e-mail address) of the
packager who created a package (one line below the identifier)
* ``%PGPSIG%``: The base64 encoded PGP signature of a package (one line below
* ``%PGPSIG%`` (**required**): The base64 encoded PGP signature of a package (one line below
the identifier)
* ``%PROVIDES%``: A list of package names that a package provides (one name per
line below the identifier)
......@@ -129,8 +129,9 @@ Desc v1
Desc v2
^^^^^^^
This version removes the ``%PGPSIG%`` field to lower the size of the created
:ref:`sync database` files.
This version removes the ``%MD5SUM%`` field as this hashing algorithm is unsafe.
Furthermore the ``%PGPSIG%`` field has been made optional to lower the size of
the created :ref:`sync database` files.
* ``%ARCH%`` (**required**): The CPU architecture of the package (one line
below the identifier)
......@@ -161,14 +162,14 @@ This version removes the ``%PGPSIG%`` field to lower the size of the created
* ``%MAKEDEPENDS%``: A list of package names required when running the
``prepare()`` and/ or ``build()`` |package function| (one name per line below
the identifier)
* ``%MD5SUM%`` (**required**): The md5 checksum of the package file (one line
below the identifier)
* ``%NAME%`` (**required**): The name of the package (one line below the
identifier)
* ``%OPTDEPENDS%``: A list of package names that can be used optionally to
extend a package's functionality (one name per line below the identifier)
* ``%PACKAGER%`` (**required**): The UID (name and e-mail address) of the
packager who created a package (one line below the identifier)
* ``%PGPSIG%``: The base64 encoded PGP signature of a package (one line below
the identifier)
* ``%PROVIDES%``: A list of package names that a package provides (one name per
line below the identifier)
* ``%REPLACES%``: A list of package names that a package replaces (one name per
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment