From 8a6933c84e0b13188b2c7330c56355f1dd69b9b4 Mon Sep 17 00:00:00 2001 From: Murilo Date: Fri, 23 Jan 2026 10:45:31 -0300 Subject: [PATCH] doc: Add rust commit messages guidance. * doc/contributing.texi (Rust Crates)[Commit messages]: New subsubsection. Change-Id: If22d6921301902417a88d2d5d8e2fad947762bee --- doc/contributing.texi | 52 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/doc/contributing.texi b/doc/contributing.texi index 2e258cd8498..e55f418c2de 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -1721,6 +1721,58 @@ tree. @xref{Packaging Rust Crates,,, guix-cookbook, GNU Guix Cookbook}, for packaging workflow. +@subsubsection Commit messages + +The commit message must have a general brief mention to entry changes +in @code{(gnu packages rust-crates)}. For changes in @code{(gnu packages +rust-sources)}, the commit message must explicitly mention all changes to the +packages. + +Here are some examples for different situations: + +@itemize + +@item +Adding a new Rust package: + +@example +gnu: Add catppuccin-whiskers. + +* gnu/packages/rust-apps.scm (catppuccin-whiskers): New variable. +* gnu/packages/rust-crates.scm (lookup-cargo-inputs) +[catppuccin-whiskers]: New entry. +@end example + +@item +Updating a simple package: + +@example +gnu: watchexec: Update to 2.3.2. + +* gnu/packages/rust-apps.scm (watchexec): Update to 2.3.2. +* gnu/packages/rust-crates.scm (lookup-cargo-inputs)[watchexec]: +Update entry. +@end example + +@item +Updating a package with sources: + +@example +gnu: typst: Update to 0.14.0. + +* gnu/packages/rust-apps.scm (typst): Update to 0.14.0. +[arguments]<#:rust>: Use rust-1.88. +* gnu/packages/rust-crates.scm (lookup-cargo-inputs)[typst]: Update +entry. +[rust-syntect-5]: Rename to rust-syntect-5.2. +[rust-syntect-5.3]: New entry. +* gnu/packages/rust-sources.scm (rust-hypher-0.1): Update to 0.1.6. +(rust-syntect-5): Rename to rust-syntect-5.2. +[inputs]: Rename cargo-inputs rust-syntect-5 to rust-syntect-5.2. +(rust-syntect-5.3): New variable. +@end example + +@end itemize @node Elm Packages @subsection Elm Packages