From 4de2612bba3c32f2286f31e4281b1a36598f8c42 Mon Sep 17 00:00:00 2001 From: Krzesimir Nowak Date: Tue, 30 Nov 2021 14:53:17 +0100 Subject: [PATCH] changelog: Update the update changelog format Mention that it should be written as a bullet list. Also, match the format to the example (put the version link inside parentheses). Update the existing changelogs too. Drop the headers, so it will be easier to process the files with a script. --- .../src/third_party/portage-stable/changelog/README.md | 7 ++++--- .../changelog/security/2021-11-25-CVE-2020-13844.md | 2 -- .../changelog/updates/2021-11-25-gcc-9.4.0.md | 2 -- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/sdk_container/src/third_party/portage-stable/changelog/README.md b/sdk_container/src/third_party/portage-stable/changelog/README.md index 11498d2f23..8c61ac11cc 100644 --- a/sdk_container/src/third_party/portage-stable/changelog/README.md +++ b/sdk_container/src/third_party/portage-stable/changelog/README.md @@ -17,6 +17,7 @@ the imperative voice for actions the user should do as a result). Security fixes of upstream packages and package updates can be kept short in most cases and follow a standard format. -As `Updates` refer to the package updates, the description of the file should -be of the following format: `Package Name [Version](link to changelog)` -Example: `Linux ([5.10.77](https://lwn.net/Articles/874852/))` +As `Updates` refer to the package updates, contents of the file should be of +the following format: `- Package Name ([Version](link to changelog))`. Example: +`- Linux ([5.10.77](https://lwn.net/Articles/874852/))`. Note the leading dash +that will create a bullet list in the rendered markdown. diff --git a/sdk_container/src/third_party/portage-stable/changelog/security/2021-11-25-CVE-2020-13844.md b/sdk_container/src/third_party/portage-stable/changelog/security/2021-11-25-CVE-2020-13844.md index 9cbd4874e5..31fcfa416f 100644 --- a/sdk_container/src/third_party/portage-stable/changelog/security/2021-11-25-CVE-2020-13844.md +++ b/sdk_container/src/third_party/portage-stable/changelog/security/2021-11-25-CVE-2020-13844.md @@ -1,3 +1 @@ -## Security - - [CVE-2020-13844](https://nvd.nist.gov/vuln/detail/CVE-2020-13844) diff --git a/sdk_container/src/third_party/portage-stable/changelog/updates/2021-11-25-gcc-9.4.0.md b/sdk_container/src/third_party/portage-stable/changelog/updates/2021-11-25-gcc-9.4.0.md index f76d5679d5..790e12f652 100644 --- a/sdk_container/src/third_party/portage-stable/changelog/updates/2021-11-25-gcc-9.4.0.md +++ b/sdk_container/src/third_party/portage-stable/changelog/updates/2021-11-25-gcc-9.4.0.md @@ -1,3 +1 @@ -## Updates - - GCC [9.4.0](https://lists.gnu.org/archive/html/info-gnu/2021-06/msg00000.html)