diff mbox series

[09/22,v3] docs/manual: document git backend handling of export-subst attribute

Message ID 91f50705b070bbd13a2e605de0ab47413accb3d5.1714858818.git.yann.morin.1998@free.fr
State Accepted
Headers show
Series support/download: extend download features and reproducibility (branch yem/git-attributes-2) | expand

Commit Message

Yann E. MORIN May 4, 2024, 9:40 p.m. UTC 
Add the changes about export-subst in the git backend, to the migrating
section of the manual.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
[Arnout: slightly extend the message, add sed command to update hash
files]
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
---
 docs/manual/migrating.adoc | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox series

Patch

diff --git a/docs/manual/migrating.adoc b/docs/manual/migrating.adoc
index c0f89cbf07..a6385260a6 100644
--- a/docs/manual/migrating.adoc
+++ b/docs/manual/migrating.adoc
@@ -123,3 +123,13 @@  LIBFOO_PRE_PATCH_HOOKS += LIBFOO_ARCH_PATCHES
 
 Note that no package in Buildroot has architecture-specific patches, and
 that such patches will most probably not be accepted.
+
+[[migrating-git-attributes]]
+=== Migrating to 2024.05
+
+The git download backend now properly expands the `export-subst`
+https://git-scm.com/docs/gitattributes[git attribute] when generating
+archives. Because of this, the archive version suffix has been updated,
+to +-br2+, so the hash files must be updated accordingly. Since
+`export-subst` is usually not used, the hash itself usually doesn't change,
+so the update can be done with `sed -r -i e 's/-br1/-br2/'`.