diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2021-06-05 21:22:45 +0200 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2021-06-07 06:34:59 +0200 |
commit | 6ecc641d087df8b8896ebd876bba592e981877c9 (patch) | |
tree | c3dc98e6b6a4a6474b21ad06e7bbc96d0e8abaf5 /doc/contributing/submitting-changes.chapter.md | |
parent | ce6b1a4f8f9cbbb7fd2d1c637bcc39fff1ef49df (diff) |
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
Diffstat (limited to 'doc/contributing/submitting-changes.chapter.md')
-rw-r--r-- | doc/contributing/submitting-changes.chapter.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/contributing/submitting-changes.chapter.md b/doc/contributing/submitting-changes.chapter.md index 0a465020092fc..97b32c15df108 100644 --- a/doc/contributing/submitting-changes.chapter.md +++ b/doc/contributing/submitting-changes.chapter.md @@ -71,6 +71,7 @@ Security fixes are submitted in the same way as other changes and thus the same - If a new version fixing the vulnerability has been released, update the package; - If the security fix comes in the form of a patch and a CVE is available, then add the patch to the Nixpkgs tree, and apply it to the package. The name of the patch should be the CVE identifier, so e.g. `CVE-2019-13636.patch`; If a patch is fetched the name needs to be set as well, e.g.: + ```nix (fetchpatch { name = "CVE-2019-11068.patch"; @@ -89,7 +90,7 @@ There is currently no policy when to remove a package. Before removing a package, one should try to find a new maintainer or fix smaller issues first. -### Steps to remove a package from Nixpkgs +### Steps to remove a package from Nixpkgs {#steps-to-remove-a-package-from-nixpkgs} We use jbidwatcher as an example for a discontinued project here. @@ -100,6 +101,7 @@ We use jbidwatcher as an example for a discontinued project here. 1. Add an alias for the package name in `pkgs/top-level/aliases.nix` (There is also `pkgs/misc/vim-plugins/aliases.nix`. Package sets typically do not have aliases, so we can't add them there.) For example in this case: + ``` jbidwatcher = throw "jbidwatcher was discontinued in march 2021"; # added 2021-03-15 ``` |