pungi/doc
Jeremy Cline ee1ee0467b extra-files: Write a metadata file enumerating extra files
Introduces a new metadata file to track arbitrary files added during the
extra-files phase. This file is placed in the root of each tree and is
called ``extra_files.json``. It is a JSON file containing a single
object, which contains a "header" key with an object describing the
metadata, and a "data" key, which is an array of objects, where each
object represents a file. Each object contains the "file", "checksums",
and "size" keys. "file" is the relative path from the tree root to the
extra file. "checksums" is an object containing one or more checksums,
where the key is the digest type and the value of that key is the hex
digest. Finally, the size is the size of the file in bytes.

For example:
{
  "header": {"version": "1.0},
  "data": [
    {
      "file": "GPL",
      "checksums": {
        "sha256": "8177f97513213526df2cf6184d8ff986c675afb514d4e68a404010521b880643"
      },
      "size": 18092
    },
    {
      "file": "release-notes/notes.html",
      "checksums": {
        "sha256": "82b1ba8db522aadf101dca6404235fba179e559b95ea24ff39ee1e5d9a53bdcb"
      },
      "size": 1120
    }
  ]
}

Signed-off-by: Jeremy Cline <jeremy@jcline.org>
Fixes: #295
2016-09-07 13:02:48 +02:00
..
_static Rewrite documentation to Sphinx. 2015-07-02 09:18:49 -04:00
_templates Rewrite documentation to Sphinx. 2015-07-02 09:18:49 -04:00
Makefile Rewrite documentation to Sphinx. 2015-07-02 09:18:49 -04:00
about.rst Add overview of Pungi to documentation 2015-12-02 10:28:11 +01:00
conf.py 4.1.8 release 2016-08-10 07:21:40 -05:00
configuration.rst extra-files: Write a metadata file enumerating extra files 2016-09-07 13:02:48 +02:00
contributing.rst Add JSON Schema for configuration 2016-09-01 10:56:15 +02:00
index.rst Move messaging into cli options 2015-11-27 10:35:08 +01:00
messaging.rst Move messaging into cli options 2015-11-27 10:35:08 +01:00
testing.rst Rewrite documentation to Sphinx. 2015-07-02 09:18:49 -04:00
update-docs.sh update the script to make docs to make 4.0 version also. update the master docs for 4.1 2016-03-09 08:06:11 -06:00