Skip to content

docs: add example for --list=variables with variable descriptions#3737

Merged
crazy-max merged 1 commit intodocker:masterfrom
allexistence:docs-variable-example
Mar 24, 2026
Merged

docs: add example for --list=variables with variable descriptions#3737
crazy-max merged 1 commit intodocker:masterfrom
allexistence:docs-variable-example

Conversation

@allexistence
Copy link
Copy Markdown
Contributor

@allexistence allexistence commented Mar 23, 2026

Summary

Add a simple example showing how variable.description appears in
docker buildx bake --list=variables

Why

While variable.description is documented in the Bake reference, the CLI docs lack a concrete example.

This improves discoverability and usability.

Related to #2556 (docs follow-up). This adds an example to improve CLI documentation for variable descriptions.

Signed-off-by: rishabh <rishank69@gmail.com>
@tonistiigi tonistiigi requested a review from dvdksn March 23, 2026 17:40
Copy link
Copy Markdown
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@crazy-max crazy-max merged commit f48bd18 into docker:master Mar 24, 2026
41 checks passed
@allexistence allexistence deleted the docs-variable-example branch April 6, 2026 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants