Skip to contentSkip to conversation

package/pkg-utils.mk: add dl_dir to show-info output

PATCH New Arnout Vandecappelle (Essensium/Mind) 2 participants 3 messages Jun 19, 2019 – Jun 22, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 package/pkg-utils.mk: add dl_dir to show-info output

It can be useful for scripts to be able to access a package's source file after download. That used to be easy, just DL_DIR/PKG_SOURCE. However, with the subdirectories in DL_DIR which can be overridden with PKG_DL_SUBDIR, that is no longer easy.

Therefore, this patch adds dl_dir to the downloads list of a package. It can be used with the following jq script to get a newline-separated list of all downloaded files:

make show-info | jq -r '.[].downloads[]? | (.dl_dir + "/" + .source)'

---
 package/pkg-utils.mk | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
package/pkg-utils.mk +2 -1
index b7280e930f..4de0bc042c 100644
@@ -104,7 +104,8 @@ define _json-info-pkg-details
 						$(call DOWNLOAD_URIS,$(dl),$(1))
 					)
 				)
-			]
+			],
+			"dl_dir": "$($(1)_DL_DIR)"
 		},
 	)
 	],
Signature · 1 line
2.21.0
#1 lore raw

PATCH 1/1 package/pkg-utils.mk: add dl_dir to show-info output

Arnout, All,

On 2019-06-19 22:17 +0200, Arnout Vandecappelle (Essensium/Mind) spake thusly:

Quoted 8 lines

It can be useful for scripts to be able to access a package's source file after download. That used to be easy, just DL_DIR/PKG_SOURCE. However, with the subdirectories in DL_DIR which can be overridden with PKG_DL_SUBDIR, that is no longer easy.

Therefore, this patch adds dl_dir to the downloads list of a package. It can be used with the following jq script to get a newline-separated list of all downloaded files:

Aha! The first extension to show-info! :-)

Quoted 12 lines

make show-info | jq -r '.[].downloads[]? | (.dl_dir + "/" + .source)'

---
 package/pkg-utils.mk | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
package/pkg-utils.mk +0 -0
index b7280e930f..4de0bc042c 100644

package/pkg-utils.mk define _json-info-pkg-details · line 108

Quoted 6 lines
package/pkg-utils.mk +2 -1
@@ -104,7 +104,8 @@ define _json-info-pkg-details
 						$(call DOWNLOAD_URIS,$(dl),$(1))
 					)
 				)
-			]
+			],
+			"dl_dir": "$($(1)_DL_DIR)"

This means that the dl_dir key is repeated as-is for all the blobs download by a package.

Instead, what about emitting the full path to said blob:

    diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
    index b7280e930f..80ad349dac 100644
    --- a/package/pkg-utils.mk
    +++ b/package/pkg-utils.mk
    @@ -104,7 +104,8 @@ define _json-info-pkg-details
     						$(call DOWNLOAD_URIS,$(dl),$(1))
     					)
     				)
    -			]
    +			],
    +			"path": "$($(1)_DL_DIR)/$(notdir $(dl))"
     		},
     	)
     ],

Or just dump the dl_dir only once:

    diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
    index b7280e930f..bd918e5faa 100644
    --- a/package/pkg-utils.mk
    +++ b/package/pkg-utils.mk
    @@ -94,6 +94,7 @@ endef
     define _json-info-pkg-details
     	"version": "$($(1)_DL_VERSION)",
     	"licenses": "$($(1)_LICENSE)",
    +	"dl_dir": "$($(1)_DL_DIR)",
     	"downloads": [
     	$(foreach dl,$(sort $($	(1)_ALL_DOWNLOADS)),
     		{

Regards,
Yann E. MORIN.

Quoted 10 lines
package/pkg-utils.mk +0 -0
 		},
 	)
 	],
Signature · 6 lines
2.21.0

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#2 lore raw

PATCH 1/1 package/pkg-utils.mk: add dl_dir to show-info output

Arnout, All,

On 2019-06-19 22:28 +0200, Yann E. MORIN spake thusly:

Quoted 4 lines

On 2019-06-19 22:17 +0200, Arnout Vandecappelle (Essensium/Mind) spake thusly:

Quoted 3 lines

Therefore, this patch adds dl_dir to the downloads list of a package. It can be used with the following jq script to get a newline-separated list of all downloaded files:

[--SNIP--]

Quoted 19 lines

Instead, what about emitting the full path to said blob:

    diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
    index b7280e930f..80ad349dac 100644
    --- a/package/pkg-utils.mk
    +++ b/package/pkg-utils.mk
    @@ -104,7 +104,8 @@ define _json-info-pkg-details
     						$(call DOWNLOAD_URIS,$(dl),$(1))
     					)
     				)
    -			]
    +			],
    +			"path": "$($(1)_DL_DIR)/$(notdir $(dl))"
     		},
     	)
     ],

Or just dump the dl_dir only once:

Quoted 12 lines
    diff --git a/package/pkg-utils.mk b/package/pkg-utils.mk
    index b7280e930f..bd918e5faa 100644
    --- a/package/pkg-utils.mk
    +++ b/package/pkg-utils.mk
    @@ -94,6 +94,7 @@ endef
     define _json-info-pkg-details
     	"version": "$($(1)_DL_VERSION)",
     	"licenses": "$($(1)_LICENSE)",
    +	"dl_dir": "$($(1)_DL_DIR)",
     	"downloads": [
     	$(foreach dl,$(sort $($	(1)_ALL_DOWNLOADS)),
     		{

Actually, there is just one thing I don't like about $($(1)_DL_DIR), is that it contains a local information: it starts with BR2_DL_DIR, which is user- and site-specific.

Instead, I'd argue we should just print $($(1)_DL_SUBDIR).

That way, the generated json blurb can even be distributed, and there is no local information that leaks. Note: even the user name (as present in $(BR2_DL_DIR)) can be a liability in some cases (true story).

Regards,
Yann E. MORIN.

Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'