ls: no-trunc opt #2138

crazy-max · 2023-11-23T14:06:54Z

follow-up #830 with the no-trunc opt.

When using ls, platforms can get wieldy easily and make output in the terminal difficult to read:

NAME/NODE            DRIVER/ENDPOINT                       STATUS     BUILDKIT               PLATFORMS
bk12                 docker-container
 \_ bk120             \_ unix:///var/run/docker.sock       running    v0.12.5                linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6
bk13                 docker-container
 \_ bk130             \_ unix:///var/run/docker.sock       running    v0.13.2                linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6
bk14                 docker-container
 \_ bk140             \_ unix:///var/run/docker.sock       inactive
bridge               docker-container
 \_ bridge0           \_ unix:///var/run/docker.sock       inactive
builder              docker-container
 \_ builder0          \_ unix:///var/run/docker.sock       running    v0.16.0                linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6
dev                  remote
 \_ dev0              \_ docker-container://buildkit-dev   inactive
sifive               docker-container
 \_ sifive0           \_ tcp://192.168.0.65:2375           error                             linux/riscv64*
test                 docker-container
 \_ test0             \_ unix:///var/run/docker.sock       inactive
test2                docker-container
 \_ test20            \_ unix:///var/run/docker.sock       inactive
test4                docker-container
 \_ test40            \_ unix:///var/run/docker.sock       stopped
default*             docker
 \_ default           \_ default                           running    v0.15.2                linux/amd64, linux/amd64/v2, linux/amd64/v3, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/mips64le, linux/mips64, linux/arm/v7, linux/arm/v6
docker-test          docker
 \_ docker-test       \_ docker-test                       running    v0.11.6                linux/amd64, linux/386
docker20             docker
 \_ docker20          \_ docker20                          running    v0.8+unknown           linux/amd64, linux/386
docker23             docker
 \_ docker23          \_ docker23                          running    v0.10.6+d52b2d5        linux/amd64, linux/386
docker24             docker
 \_ docker24          \_ docker24                          running    v0.11.6                linux/amd64, linux/386
remote-ssh           docker
 \_ remote-ssh        \_ remote-ssh                        running    v0.11.6+0a15675913b7   linux/arm64, linux/arm/v7, linux/arm/v6

With this change only platforms are truncated by default and only when using the table format. We only display "common" platforms with a limitation to 4 and put add a count for number of variants found:

NAME/NODE            DRIVER/ENDPOINT                       STATUS     BUILDKIT               PLATFORMS
bk12                 docker-container
 \_ bk120             \_ unix:///var/run/docker.sock       running    v0.12.5                linux/amd64 (+3), linux/arm64, linux/arm (+2), linux/ppc64le, (5 more)
bk13                 docker-container
 \_ bk130             \_ unix:///var/run/docker.sock       running    v0.13.2                linux/amd64 (+3), linux/arm64, linux/arm (+2), linux/ppc64le, (5 more)  
bk14                 docker-container
 \_ bk140             \_ unix:///var/run/docker.sock       inactive
bridge               docker-container
 \_ bridge0           \_ unix:///var/run/docker.sock       inactive
builder              docker-container
 \_ builder0          \_ unix:///var/run/docker.sock       running    v0.16.0                linux/amd64 (+3), linux/arm64, linux/arm (+2), linux/ppc64le, (5 more)  
dev                  remote
 \_ dev0              \_ docker-container://buildkit-dev   inactive
sifive               docker-container
 \_ sifive0           \_ tcp://192.168.0.65:2375           error                             linux/riscv64*
test                 docker-container
 \_ test0             \_ unix:///var/run/docker.sock       inactive
test2                docker-container
 \_ test20            \_ unix:///var/run/docker.sock       inactive
test4                docker-container
 \_ test40            \_ unix:///var/run/docker.sock       stopped
default*             docker
 \_ default           \_ default                           running    v0.15.2                linux/amd64 (+3), linux/arm64, linux/arm (+2), linux/ppc64le, (5 more)  
docker-test          docker
 \_ docker-test       \_ docker-test                       running    v0.11.6                linux/amd64, linux/386
docker20             docker
 \_ docker20          \_ docker20                          running    v0.8+unknown           linux/amd64, linux/386
docker23             docker
 \_ docker23          \_ docker23                          running    v0.10.6+d52b2d5        linux/amd64, linux/386
docker24             docker
 \_ docker24          \_ docker24                          running    v0.11.6                linux/amd64, linux/386
remote-ssh           docker
 \_ remote-ssh        \_ remote-ssh                        running    v0.11.6+0a15675913b7   linux/arm64, linux/arm (+2)

crazy-max · 2023-11-23T14:09:35Z

commands/ls.go

+	majorPlatforms := map[string]struct{}{
+		"linux/amd64":   {},
+		"linux/arm64":   {},
+		"linux/arm/v7":  {},
+		"linux/mips64":  {},
+		"linux/ppc64le": {},
+		"linux/riscv64": {},
+		"linux/s390x":   {},
+	}


Following platforms take priority but let me know if we should change that.

crazy-max · 2023-11-23T14:19:08Z

commands/ls_test.go

+			name:      "all preferred",
+			platforms: []string{"darwin/arm64*", "linux/arm64*", "linux/arm/v5*", "linux/arm/v6*", "linux/arm/v7*", "windows/arm64*"},
+			expected:  []string{"linux/arm64*", "linux/arm/v7*", "darwin/arm64*", "linux/arm/v5*"},
+			truncated: true,
+			max:       4,


Should we always display all preferred platforms even if it exceeds the limit?

crazy-max · 2023-11-23T14:19:47Z

commands/ls_test.go

+			name:      "no major preferred",
+			platforms: []string{"linux/amd64/v2*", "linux/arm/v6*", "linux/mips64le*", "linux/amd64", "linux/amd64/v3", "linux/386", "linux/arm64", "linux/riscv64", "linux/ppc64le", "linux/s390x", "linux/mips64", "linux/arm/v7"},
+			expected:  []string{"linux/amd64", "linux/arm64", "linux/riscv64", "linux/ppc64le"},
+			truncated: true,
+			max:       4,


Should preferred platforms take priority even if not part of major ones?

tonistiigi

I think a better output could be linux/arm64, linux/amd64 (N more)

For the amd64 variants, I guess we could just show the maximum variant with truncated mode.

crazy-max · 2023-11-30T15:18:29Z

I think a better output could be linux/arm64, linux/amd64 (N more)

👍

For the amd64 variants, I guess we could just show the maximum variant with truncated mode.

Hum so for linux/amd64, linux/amd64/v2, linux/amd64/v3 we should only display linux/amd64/v3 or linux/amd64, linux/amd64/v3? User might be confused if we just display max variant only. I guess this is similar to linux/arm and linux/arm/v7 🤔

tonistiigi · 2023-11-30T19:01:34Z

User might be confused if we just display max variant only.

If you think it is confusing, then I think better to not show variant at all in truncated view. We should not show linux/amd64/v1 or linux/amd64/v2 if that is not the max variant. The question is though if linux/amd64 (2 more) untruncated to linux/amd64 linux/amd64/v2 linux/amd64/v3` makes much sense.

crazy-max · 2023-12-12T15:45:10Z

commands/ls_test.go

+			platforms: []string{"linux/arm64*", "linux/amd64", "linux/amd64/v2", "linux/riscv64", "linux/ppc64le", "linux/s390x", "linux/386", "linux/mips64le", "linux/mips64", "linux/arm/v7", "linux/arm/v6"},
+			expected:  []string{"linux/arm64*", "linux/amd64", "linux/arm/v7", "linux/ppc64le"},


I changed the priority over popular platforms to iterate over them until finding a match instead of using a map so we add some weight from the list.

I think this truncated output makes sense based on popular CPU architectures. I will take a look about stripping the variant.

Signed-off-by: CrazyMax <[email protected]>

crazy-max · 2024-10-03T09:22:21Z

@tonistiigi Updated to take variants into account, see PR description.

crazy-max added the area/cli label Nov 23, 2023

crazy-max commented Nov 23, 2023

View reviewed changes

crazy-max force-pushed the ls-notrunc branch 2 times, most recently from db1dd93 to 94cdae5 Compare November 23, 2023 14:18

crazy-max commented Nov 23, 2023

View reviewed changes

crazy-max mentioned this pull request Nov 23, 2023

Add a --quiet --no-trunc option to docker buildx ls #380

Closed

crazy-max marked this pull request as ready for review November 23, 2023 14:23

tonistiigi reviewed Nov 28, 2023

View reviewed changes

crazy-max force-pushed the ls-notrunc branch 2 times, most recently from cda6a69 to 3a19fa5 Compare November 30, 2023 15:12

crazy-max force-pushed the ls-notrunc branch from 3a19fa5 to 494f85f Compare December 12, 2023 14:00

crazy-max commented Dec 12, 2023

View reviewed changes

crazy-max marked this pull request as draft December 23, 2023 16:37

thompson-shaun added this to the v0.19.0 milestone Oct 2, 2024

ls: no-trunc opt

820f5e7

Signed-off-by: CrazyMax <[email protected]>

crazy-max force-pushed the ls-notrunc branch from 494f85f to 820f5e7 Compare October 3, 2024 09:20

crazy-max modified the milestones: v0.19.0, v0.18.0 Oct 3, 2024

github-actions bot added area/docs area/tests labels Oct 3, 2024

crazy-max marked this pull request as ready for review October 3, 2024 09:23

thompson-shaun assigned tonistiigi Oct 3, 2024

tonistiigi approved these changes Oct 3, 2024

View reviewed changes

tonistiigi merged commit 7c91f3d into docker:master Oct 3, 2024
108 checks passed

crazy-max deleted the ls-notrunc branch October 3, 2024 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ls: no-trunc opt #2138

ls: no-trunc opt #2138

crazy-max commented Nov 23, 2023 •

edited

Loading

crazy-max Nov 23, 2023

crazy-max Nov 23, 2023

crazy-max Nov 23, 2023

tonistiigi left a comment •

edited

Loading

crazy-max commented Nov 30, 2023

tonistiigi commented Nov 30, 2023

crazy-max Dec 12, 2023

crazy-max commented Oct 3, 2024

		platforms: []string{"linux/arm64*", "linux/amd64", "linux/amd64/v2", "linux/riscv64", "linux/ppc64le", "linux/s390x", "linux/386", "linux/mips64le", "linux/mips64", "linux/arm/v7", "linux/arm/v6"},
		expected: []string{"linux/arm64*", "linux/amd64", "linux/arm/v7", "linux/ppc64le"},

ls: no-trunc opt #2138

ls: no-trunc opt #2138

Conversation

crazy-max commented Nov 23, 2023 • edited Loading

crazy-max Nov 23, 2023

Choose a reason for hiding this comment

crazy-max Nov 23, 2023

Choose a reason for hiding this comment

crazy-max Nov 23, 2023

Choose a reason for hiding this comment

tonistiigi left a comment • edited Loading

Choose a reason for hiding this comment

crazy-max commented Nov 30, 2023

tonistiigi commented Nov 30, 2023

crazy-max Dec 12, 2023

Choose a reason for hiding this comment

crazy-max commented Oct 3, 2024

crazy-max commented Nov 23, 2023 •

edited

Loading

tonistiigi left a comment •

edited

Loading