flatcar-scripts/changelog
James Le Cuirot 8e5b5af225
dev-lang/rust: Drop our custom package in favour of upstream Gentoo's
It is not clear why this was forked originally. One reason was to avoid
the sys-apps/lsb-release dependency, but it probably wasn't just that.
It seems likely that the upstream package did not support cross targets
at the time. Now it does.

It appears that LTO was previously enabled by us following Gentoo rather
than through an explicit decision. They now disable it by default, so we
do likewise. It previously used "fat" LTO, which makes Rust especially
slow to build and reportedly made rustc slower than with "thin" LTO!
There seems little benefit in using thin LTO given that we rebuild Rust
almost as much as the packages that use it, plus we don't enable LTO
anywhere else.

We still avoid rustdoc to keep the size down using INSTALL_MASK. This
isn't as good as not building it in the first place, but this alone
isn't worth keeping a fork.

Cross targets are now handled via the admittedly experimental
RUST_CROSS_TARGETS support. This has been in place for a while, and I
think it is fairly widely used now. If it does disappear, it would
almost certainly be for something even better.

This also updates Rust from 1.80.0 to 1.80.1.

Signed-off-by: James Le Cuirot <jlecuirot@microsoft.com>
2024-08-15 16:54:11 +01:00
..
bugfixes changelog: add entries 2024-07-23 12:01:30 +02:00
changes changelog: Add an entry 2024-08-09 14:12:27 +02:00
security changelog: Add entries 2024-08-14 17:15:15 +02:00
updates dev-lang/rust: Drop our custom package in favour of upstream Gentoo's 2024-08-15 16:54:11 +01:00
README.md Use new github org name "flatcar" 2022-09-14 14:33:27 +02:00

The changelog directory contains the description of the changes introduced into the repository. The changes are essentially divided into 4 categories:

  • changes: PRs bringing Changes and/or Enhancements
  • bugfixes: PRs fixing existing issues
  • security: PRs fixing security issues
  • updates: PRs updating packages

How to add the file

Based on the category the PR falls into create a new file in the respective directory with the filename format YYYY-MM-DD-<few-words-about-the-change>.md (can be generated via: $(date '+%Y-%m-%d')-<few-words-about-the-change>.md). The file should contain a markdown bullet point entry (- TEXT...).

Example for the bugfix section:

- The Torcx profile `docker-1.12-no` got fixed to reference the current Docker version instead of 19.03 which wasn't found on the image, causing Torcx to fail to provide Docker [scripts#1456](https://github.com/flatcar/scripts/pull/1456)

The contents of the file should describe the changes in a concise manner, and only contain information relevant for the end users. (use the past tense for the change/bugfix description to avoid confusion with 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, 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.

The security section follows this format:

- Package Name ([CVE-NUMBER](NIST-LINK), [CVE-NUMBER](NIST-LINK), ...)

E.g., Linux ([CVE-2021-4002](https://nvd.nist.gov/vuln/detail/CVE-2021-4002), [CVE-2020-27820](https://nvd.nist.gov/vuln/detail/CVE-2020-27820)).