From 4c83b8f38d12e13bcfd69a52bc2be8d87b7fcf66 Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@thegeeklab.de>
Date: Tue, 1 Nov 2022 21:49:13 +0100
Subject: [PATCH] docs: add escape example for cache_from parameter (#148)

---
 _docs/data/data.yaml | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/_docs/data/data.yaml b/_docs/data/data.yaml
index eba41ca..2c5cf72 100644
--- a/_docs/data/data.yaml
+++ b/_docs/data/data.yaml
@@ -147,7 +147,20 @@ properties:
     required: false
 
   cache_from:
-    description: Images to consider as cache sources.
+    description: |
+      Images to consider as [cache sources](https://docs.docker.com/engine/reference/commandline/buildx_build/#cache-from). To properly work,
+      commas used in the cache source entries need to be escaped:
+
+      ```Yaml
+      - name: Build
+        image: thegeeklab/drone-docker-buildx:20
+        settings:
+          repo: example/repo
+          cache_from:
+            # using quotes double-escaping is required
+            - "type=registry\\\\,ref=example"
+            - 'type=foo\\,ref=bar'
+      ```
     type: list
     required: false