diff mbox series

[6/6,v2] docs/manual: document git backend handling of export-subst attribute

Message ID a18eb5b69ceafeeccb94bb9dba1aba227d5e25bd.1695069059.git.yann.morin.1998@free.fr
State New
Headers show
Series support/downloaf/git: add support for git attirbutes (branch yem/git-attributes) | expand

Commit Message

Yann E. MORIN Sept. 18, 2023, 8:31 p.m. UTC
Add the changes about export-subst in the got backend, to the migrating
section of the manual.

Reorganise the section so it is more digestible.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Cc: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
---
 docs/manual/migrating.txt | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)
diff mbox series

Patch

diff --git a/docs/manual/migrating.txt b/docs/manual/migrating.txt
index 2667aeab96..f95112e84d 100644
--- a/docs/manual/migrating.txt
+++ b/docs/manual/migrating.txt
@@ -90,13 +90,18 @@  An RPATH pointing to +$(HOST_DIR)/usr/lib+ is no longer accepted.
 [[migrating-svn-externals]]
 === Migrating to 2023.11
 
-Before Buildroot 2023.11, the subversion download backend unconditionally
-retrieved the external references (objects with an `svn:externals`
-property). Starting with 2023.11, externals are no longer retrieved by
-default; if you need them, set +LIBFOO_SVN_EXTERNALS+ to +YES+. This
-change implies that:
+==== Changes in the download infrastructure
+
+1. the git download backend now properly expands the `export-subst`
+   https://git-scm.com/docs/gitattributes[git attribute] when generating
+   archives;
+2. the subversion download backend does no longer retrieve the external
+   references (objects with an `svn:externals` property) by default; if
+   you need them, set +LIBFOO_SVN_EXTERNALS+ to +YES+.
+
+These changes imply that:
 
 * the generated archive content may change, and thus the hashes may need
   to be updated appropriately;
-* the archive version suffix has been updated to +-br3+, so the hash
-  files must be updated appropriately.
+* the archive version suffix has been updated, to +-br2+ for git, and to
+  +-br3+ for subversion, so the hash files must be updated appropriately.