commit: 464fd32ed05e175b359ca4ba05e2418095c125dd
Author: Matt Jolly <kangie <AT> gentoo <DOT> org>
AuthorDate: Tue Jun 3 04:31:38 2025 +0000
Commit: Matt Jolly <kangie <AT> gentoo <DOT> org>
CommitDate: Tue Jun 3 04:31:38 2025 +0000
URL: https://gitweb.gentoo.org/proj/rust-patches.git/commit/?id=464fd32e
Initial commit with README
Signed-off-by: Matt Jolly <kangie <AT> gentoo.org>
README.rst | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..9999e72
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,24 @@
+###################
+Gentoo Rust Patches
+###################
+
+This repository contains patches required to build Rust on Gentoo Linux. These
patches were previously
+part of the main Gentoo repository but have been moved here due to their size
and to make maintenance easier.
+
+The patches are applied to the Rust source code during the build process. They
address various issues such as
+compatibility with the Gentoo environment, specific compiler flags, and other
adjustments needed for a successful build,
+or are backports to fix specific issues.
+
+Usage
+=====
+
+A branch will be created for each new Rust release (e.g. ``1.88``), and
patches will be added to that branch as needed.
+
+Tags for ``${PV}`` will be created for each release, e.g. ``1.88.0``,
``1.88.1``, etc., to track the specific versions of
+Rust that these patches apply to. Revbumps will be tagged as required - if a
patch is added or updated, a tag will be
+created for the new version (e.g. ``1.88.0-r1``).
+
+``master`` will contain patches required for ``nightly`` (live / ``9999``)
ebuilds and will be updated as needed.
+
+To use the patches, you can clone this repository and apply the patches to the
Rust source code before building
+(or use the Gentoo ebuild system which will handle this automatically!).
