[openwrt/openwrt] scripts/feeds: implement support for --root option

[LEDE Commits]

ansuel pushed a commit to openwrt/openwrt.git, branch main:
https://git.openwrt.org/e112fd8e59e37ae323fdaebb74bdd6084176d8e4

commit e112fd8e59e37ae323fdaebb74bdd6084176d8e4
Author: Christian Marangi <ansuelsmth at gmail.com>
AuthorDate: Mon Oct 13 01:59:52 2025 +0200

    scripts/feeds: implement support for --root option
    
    Some feeds might need to set the source for their packages in a
    different directory than the cloned one.
    
    For example a feed "test" might be an entire repository and the relevant
    packages that wants to be included are in the directory "foo".
    
    In such scenario the source info in the package will result in something
    like "feeds/test/foo/network/dnsmasq" instead of an expected entry like
    "feeds/test/network/dnsmasq".
    
    To give a more real-world example, this problem is currently present
    with OpenWrt SDK where the SDK clone the entire OpenWrt core repository
    as "base" feeds but the package are present in the "package" directory.
    
    This cause every package to have the source entry set to
    "feeds/base/package/..." conflicting with what a non-SDK build do with
    setting the source entry to "feeds/base/..."
    
    To solve this, actually enable support for "flags" in the feeds script
    and implement a new option "--root" to set the root directory for the
    defined feed to an inner directory.
    
    The "flags" in the feed script are no more than argument option that can
    be defined right after the "src-" type in the feed.conf file.
    
    This feature was partially implemented but never actually used for
    anything keeping it dormant with all the core piece there (the pattern
    regex always accounted for these extra option but they were never passed
    to the relevant functions)
    
    An example of the "--root" flag is the following:
    
    src-git --root=package base https://git.openwrt.org/openwrt/openwrt.git;main
    
    With "--root" defined, the script will append "_root" to the feed name
    clone directory and will create a symbolic link named with the feed name
    and pointing to the feed name clone directory + the value in root.
    
    From the previous example:
    
    feed name: base -> clone directory: base_root
    symbolic link: base -> base_root/package
    
    The script internally reference the "_root" directory for every update
    operation and OpenWrt build system transparently use the feed name
    directory to reference feed packages producing consistent source info
    entry.
    
    Link: https://github.com/openwrt/openwrt/pull/20396
    Signed-off-by: Christian Marangi <ansuelsmth at gmail.com>
---
 scripts/feeds | 39 +++++++++++++++++++++++++--------------
 1 file changed, 25 insertions(+), 14 deletions(-)

diff --git a/scripts/feeds b/scripts/feeds
index 959995c7af..05169b2940 100755
--- a/scripts/feeds
+++ b/scripts/feeds
@@ -198,7 +198,7 @@ my %update_method = (
 # src-git: pull broken
 # src-cpy: broken if `basename $src` != $name
 
-sub update_feed_via($$$$$$$) {
+sub update_feed_via($$$$$$$$) {
 	my $type = shift;
 	my $name = shift;
 	my $src = shift;
@@ -206,22 +206,32 @@ sub update_feed_via($$$$$$$) {
 	my $force = shift;
 	my $rebase = shift;
 	my $stash = shift;
+	my $flags = shift;
 
 	my $m = $update_method{$type};
-	my $localpath = "./feeds/$name";
-	my $safepath = $localpath;
-	$safepath =~ s/'/'\\''/;
+	my $safename = $name;
+	$safename =~ s/'/'\\''/;
+	my $localpath = "./feeds/$safename";
+	my $localpath_orig;
+	if (defined $flags->{'root'}) {
+		$safename .= "_root";
+		$localpath_orig = $localpath;
+		$localpath .= "_root";
+	}
 	my ($base_branch, $branch) = split(/;/, $src, 2);
 	my ($base_commit, $commit) = split(/\^/, $src, 2);
 
 	if( $relocate || !$m->{'update'} || !-d "$localpath/$m->{'controldir'}" ) {
-		system("rm -rf '$safepath'");
+		if (defined $flags->{'root'}) {
+			system("rm -rf $localpath_orig; ln -s $safename/$flags->{'root'} $localpath_orig");
+		}
+		system("rm -rf '$localpath'");
 		if ($m->{'init_branch'} and $branch) {
-			system(sprintf($m->{'init_branch'}, $branch, $base_branch, $safepath)) == 0 or return 1;
+			system(sprintf($m->{'init_branch'}, $branch, $base_branch, $localpath)) == 0 or return 1;
 		} elsif ($m->{'init_commit'} and $commit) {
-			system(sprintf($m->{'init_commit'}, $base_commit, $safepath, $safepath, $commit, $commit)) == 0 or return 1;
+			system(sprintf($m->{'init_commit'}, $base_commit, $localpath, $localpath, $commit, $commit)) == 0 or return 1;
 		} else {
-			system(sprintf($m->{'init'}, $src, $safepath)) == 0 or return 1;
+			system(sprintf($m->{'init'}, $src, $localpath)) == 0 or return 1;
 		}
 	} elsif ($m->{'init_commit'} and $commit) {
 		# in case git hash has been provided don't update the feed
@@ -236,11 +246,11 @@ sub update_feed_via($$$$$$$) {
 		if ($stash && exists $m->{'update_stash'}) {
 			$update_cmd = $m->{'update_stash'};
 		}
-		system("cd '$safepath'; $update_cmd") == 0 or return 1;
+		system("cd '$localpath'; $update_cmd") == 0 or return 1;
 	}
 	if ($m->{'post_update'}) {
 		my $cmd = $m->{'post_update'};
-		system("cd '$safepath'; $cmd") == 0 or return 1;
+		system("cd '$localpath'; $cmd") == 0 or return 1;
 	}
 
 	return 0;
@@ -793,7 +803,7 @@ sub uninstall {
 	return 0;
 }
 
-sub update_feed($$$$$$)
+sub update_feed($$$$$$$)
 {
 	my $type=shift;
 	my $name=shift;
@@ -801,6 +811,7 @@ sub update_feed($$$$$$)
 	my $force_update=shift;
 	my $rebase_update=shift;
 	my $stash_update=shift;
+	my $flags=shift;
 	my $force_relocate=update_location( $name, "@$src" );
 	my $rv=0;
 
@@ -815,7 +826,7 @@ sub update_feed($$$$$$)
 	my $failed = 1;
 	foreach my $feedsrc (@$src) {
 		warn "Updating feed '$name' from '$feedsrc' ...\n";
-		if (update_feed_via($type, $name, $feedsrc, $force_relocate, $force_update, $rebase_update, $stash_update) != 0) {
+		if (update_feed_via($type, $name, $feedsrc, $force_relocate, $force_update, $rebase_update, $stash_update, $flags) != 0) {
 			if ($force_update) {
 				$rv=1;
 				$failed=0;
@@ -860,10 +871,10 @@ sub update {
 
 	my @index_feeds;
 	foreach my $feed (@feeds) {
-		my ($type, $name, $src) = @$feed;
+		my ($type, $name, $src, $flags) = @$feed;
 		next unless $#ARGV == -1 or $opts{a} or $argv_feeds{$name};
 		if (not $opts{i}) {
-			update_feed($type, $name, $src, $opts{f}, $opts{r}, $opts{s}) == 0 or $failed=1;
+			update_feed($type, $name, $src, $opts{f}, $opts{r}, $opts{s}, $flags) == 0 or $failed=1;
 		}
 		push @index_feeds, $name;
 	}