Skip to content
Snippets Groups Projects
Commit 4bc809fa authored by Jeremy Soller's avatar Jeremy Soller
Browse files

Merge branch 'add-policy' into 'master'

Add the "Package Policy" from the book

See merge request !317
parents 7c0e5fcc 8f8e007f
No related branches found
No related tags found
1 merge request!317Add the "Package Policy" from the book
......@@ -29,4 +29,14 @@ A collection of software ports for Redox.
In order for this repository to be useful, it must be set up with an environment
from the [redox](https://gitlab.redox-os.org/redox-os/redox) repository.
### Package Policy
When you send your recipe to upstream (to become a public package), you must follow these rules:
- Keep the static linking of libraries, there's an exception if the library/runtime is bigger than 50MB, big libraries/runtimes like LLVM can be dynamically linked.
- Respect the ABI separation of the packages, for example, if `openssl1` is available and some program need `openssl3`, you will create a recipe for `openssl3` and not rename the `openssl1`, as it will break the ABI of the dependent packages.
- If your recipe download a tarball you need to create a BLAKE3 hash for it, you can learn how to do it [here](https://doc.redox-os.org/book/ch09-03-porting-applications.html#create-a-blake3-hash-for-your-recipee).
- Verify if the recipe has some license violation, in case of doubt ask us on the [chat](https://doc.redox-os.org/book/ch13-01-chat.html).
- If your recipe is incomplete you will add it on the `wip` folder, you don't need to insert a BLAKE3 hash (it's quicker to test new tarball versions without checksum) but you need to insert a `#TODO` on the beginning of the `recipe.toml` and explain what's missing. Once the recipe is ready, add the BLAKE3 hash if needed and move the folder to the appropriate category.
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
\ No newline at end of file
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