All of lore.kernel.org
 help / color / mirror / Atom feed
From: Stephen Boyd <swboyd@chromium.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Douglas Anderson <dianders@chromium.org>
Cc: linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org,
	dri-devel@lists.freedesktop.org, freedreno@lists.freedesktop.org,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Rob Clark <robdclark@gmail.com>,
	Russell King <rmk+kernel@arm.linux.org.uk>,
	Saravana Kannan <saravanak@google.com>
Subject: [PATCH v6 05/35] drm/of: Add a drm_of_aggregate_probe() API
Date: Thu, 27 Jan 2022 12:01:11 -0800	[thread overview]
Message-ID: <20220127200141.1295328-6-swboyd@chromium.org> (raw)
In-Reply-To: <20220127200141.1295328-1-swboyd@chromium.org>

Similar to drm_of_component_probe() but using the new API that registers
a driver instead of an ops struct. This allows us to migrate the users
of drm_of_component_probe() to the new way of doing things.

Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Rob Clark <robdclark@gmail.com>
Cc: Russell King <rmk+kernel@arm.linux.org.uk>
Cc: Saravana Kannan <saravanak@google.com>
Signed-off-by: Stephen Boyd <swboyd@chromium.org>
---
 drivers/gpu/drm/drm_of.c | 85 +++++++++++++++++++++++++++++++---------
 include/drm/drm_of.h     | 12 ++++++
 2 files changed, 78 insertions(+), 19 deletions(-)

diff --git a/drivers/gpu/drm/drm_of.c b/drivers/gpu/drm/drm_of.c
index 59d368ea006b..0fe822319aae 100644
--- a/drivers/gpu/drm/drm_of.c
+++ b/drivers/gpu/drm/drm_of.c
@@ -99,30 +99,18 @@ void drm_of_component_match_add(struct device *master,
 }
 EXPORT_SYMBOL_GPL(drm_of_component_match_add);
 
-/**
- * drm_of_component_probe - Generic probe function for a component based master
- * @dev: master device containing the OF node
- * @compare_of: compare function used for matching components
- * @m_ops: component master ops to be used
- *
- * Parse the platform device OF node and bind all the components associated
- * with the master. Interface ports are added before the encoders in order to
- * satisfy their .bind requirements
- * See Documentation/devicetree/bindings/graph.txt for the bindings.
- *
- * Returns zero if successful, or one of the standard error codes if it fails.
- */
-int drm_of_component_probe(struct device *dev,
+static int _drm_of_component_probe(struct device *dev,
 			   int (*compare_of)(struct device *, void *),
-			   const struct component_master_ops *m_ops)
+			   struct component_match **matchptr)
 {
 	struct device_node *ep, *port, *remote;
-	struct component_match *match = NULL;
 	int i;
 
 	if (!dev->of_node)
 		return -EINVAL;
 
+	*matchptr = NULL;
+
 	/*
 	 * Bind the crtc's ports first, so that drm_of_find_possible_crtcs()
 	 * called from encoder's .bind callbacks works as expected
@@ -133,7 +121,7 @@ int drm_of_component_probe(struct device *dev,
 			break;
 
 		if (of_device_is_available(port->parent))
-			drm_of_component_match_add(dev, &match, compare_of,
+			drm_of_component_match_add(dev, matchptr, compare_of,
 						   port);
 
 		of_node_put(port);
@@ -144,7 +132,7 @@ int drm_of_component_probe(struct device *dev,
 		return -ENODEV;
 	}
 
-	if (!match) {
+	if (!*matchptr) {
 		dev_err(dev, "no available port\n");
 		return -ENODEV;
 	}
@@ -174,17 +162,76 @@ int drm_of_component_probe(struct device *dev,
 				continue;
 			}
 
-			drm_of_component_match_add(dev, &match, compare_of,
+			drm_of_component_match_add(dev, matchptr, compare_of,
 						   remote);
 			of_node_put(remote);
 		}
 		of_node_put(port);
 	}
 
+	return 0;
+}
+
+/**
+ * drm_of_component_probe - Generic probe function for a component based master
+ * @dev: master device containing the OF node
+ * @compare_of: compare function used for matching components
+ * @m_ops: component master ops to be used
+ *
+ * Parse the platform device OF node and bind all the components associated
+ * with the master. Interface ports are added before the encoders in order to
+ * satisfy their .bind requirements
+ * See Documentation/devicetree/bindings/graph.txt for the bindings.
+ *
+ * Deprecated: Use drm_of_aggregate_probe() instead.
+ *
+ * Returns zero if successful, or one of the standard error codes if it fails.
+ */
+int drm_of_component_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   const struct component_master_ops *m_ops)
+{
+
+	struct component_match *match;
+	int ret;
+
+	ret = _drm_of_component_probe(dev, compare_of, &match);
+	if (ret)
+		return ret;
+
 	return component_master_add_with_match(dev, m_ops, match);
 }
 EXPORT_SYMBOL(drm_of_component_probe);
 
+
+/**
+ * drm_of_aggregate_probe - Generic probe function for a component based aggregate host
+ * @dev: device containing the OF node
+ * @compare_of: compare function used for matching components
+ * @adrv: aggregate driver to be used
+ *
+ * Parse the platform device OF node and bind all the components associated
+ * with the aggregate device. Interface ports are added before the encoders in
+ * order to satisfy their .bind_component requirements
+ * See Documentation/devicetree/bindings/graph.txt for the bindings.
+ *
+ * Returns zero if successful, or one of the standard error codes if it fails.
+ */
+int drm_of_aggregate_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   struct aggregate_driver *adrv)
+{
+	struct component_match *match;
+	int ret;
+
+	ret = _drm_of_component_probe(dev, compare_of, &match);
+	if (ret)
+		return ret;
+
+	return component_aggregate_register(dev, adrv, match);
+}
+EXPORT_SYMBOL(drm_of_aggregate_probe);
+
 /*
  * drm_of_encoder_active_endpoint - return the active encoder endpoint
  * @node: device tree node containing encoder input ports
diff --git a/include/drm/drm_of.h b/include/drm/drm_of.h
index 99f79ac8b4cd..7c7b0d8377a7 100644
--- a/include/drm/drm_of.h
+++ b/include/drm/drm_of.h
@@ -7,6 +7,7 @@
 #include <drm/drm_bridge.h>
 #endif
 
+struct aggregate_driver;
 struct component_master_ops;
 struct component_match;
 struct device;
@@ -40,6 +41,9 @@ void drm_of_component_match_add(struct device *master,
 int drm_of_component_probe(struct device *dev,
 			   int (*compare_of)(struct device *, void *),
 			   const struct component_master_ops *m_ops);
+int drm_of_aggregate_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   struct aggregate_driver *adrv);
 int drm_of_encoder_active_endpoint(struct device_node *node,
 				   struct drm_encoder *encoder,
 				   struct of_endpoint *endpoint);
@@ -79,6 +83,14 @@ drm_of_component_probe(struct device *dev,
 	return -EINVAL;
 }
 
+static inline int
+drm_of_aggregate_probe(struct device *dev,
+		       int (*compare_of)(struct device *, void *),
+		       struct aggregate_driver *adrv)
+{
+	return -EINVAL;
+}
+
 static inline int drm_of_encoder_active_endpoint(struct device_node *node,
 						 struct drm_encoder *encoder,
 						 struct of_endpoint *endpoint)
-- 
https://chromeos.dev


WARNING: multiple messages have this Message-ID (diff)
From: Stephen Boyd <swboyd@chromium.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Douglas Anderson <dianders@chromium.org>
Cc: Saravana Kannan <saravanak@google.com>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	linux-arm-msm@vger.kernel.org,
	Russell King <rmk+kernel@arm.linux.org.uk>,
	freedreno@lists.freedesktop.org
Subject: [PATCH v6 05/35] drm/of: Add a drm_of_aggregate_probe() API
Date: Thu, 27 Jan 2022 12:01:11 -0800	[thread overview]
Message-ID: <20220127200141.1295328-6-swboyd@chromium.org> (raw)
In-Reply-To: <20220127200141.1295328-1-swboyd@chromium.org>

Similar to drm_of_component_probe() but using the new API that registers
a driver instead of an ops struct. This allows us to migrate the users
of drm_of_component_probe() to the new way of doing things.

Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Rob Clark <robdclark@gmail.com>
Cc: Russell King <rmk+kernel@arm.linux.org.uk>
Cc: Saravana Kannan <saravanak@google.com>
Signed-off-by: Stephen Boyd <swboyd@chromium.org>
---
 drivers/gpu/drm/drm_of.c | 85 +++++++++++++++++++++++++++++++---------
 include/drm/drm_of.h     | 12 ++++++
 2 files changed, 78 insertions(+), 19 deletions(-)

diff --git a/drivers/gpu/drm/drm_of.c b/drivers/gpu/drm/drm_of.c
index 59d368ea006b..0fe822319aae 100644
--- a/drivers/gpu/drm/drm_of.c
+++ b/drivers/gpu/drm/drm_of.c
@@ -99,30 +99,18 @@ void drm_of_component_match_add(struct device *master,
 }
 EXPORT_SYMBOL_GPL(drm_of_component_match_add);
 
-/**
- * drm_of_component_probe - Generic probe function for a component based master
- * @dev: master device containing the OF node
- * @compare_of: compare function used for matching components
- * @m_ops: component master ops to be used
- *
- * Parse the platform device OF node and bind all the components associated
- * with the master. Interface ports are added before the encoders in order to
- * satisfy their .bind requirements
- * See Documentation/devicetree/bindings/graph.txt for the bindings.
- *
- * Returns zero if successful, or one of the standard error codes if it fails.
- */
-int drm_of_component_probe(struct device *dev,
+static int _drm_of_component_probe(struct device *dev,
 			   int (*compare_of)(struct device *, void *),
-			   const struct component_master_ops *m_ops)
+			   struct component_match **matchptr)
 {
 	struct device_node *ep, *port, *remote;
-	struct component_match *match = NULL;
 	int i;
 
 	if (!dev->of_node)
 		return -EINVAL;
 
+	*matchptr = NULL;
+
 	/*
 	 * Bind the crtc's ports first, so that drm_of_find_possible_crtcs()
 	 * called from encoder's .bind callbacks works as expected
@@ -133,7 +121,7 @@ int drm_of_component_probe(struct device *dev,
 			break;
 
 		if (of_device_is_available(port->parent))
-			drm_of_component_match_add(dev, &match, compare_of,
+			drm_of_component_match_add(dev, matchptr, compare_of,
 						   port);
 
 		of_node_put(port);
@@ -144,7 +132,7 @@ int drm_of_component_probe(struct device *dev,
 		return -ENODEV;
 	}
 
-	if (!match) {
+	if (!*matchptr) {
 		dev_err(dev, "no available port\n");
 		return -ENODEV;
 	}
@@ -174,17 +162,76 @@ int drm_of_component_probe(struct device *dev,
 				continue;
 			}
 
-			drm_of_component_match_add(dev, &match, compare_of,
+			drm_of_component_match_add(dev, matchptr, compare_of,
 						   remote);
 			of_node_put(remote);
 		}
 		of_node_put(port);
 	}
 
+	return 0;
+}
+
+/**
+ * drm_of_component_probe - Generic probe function for a component based master
+ * @dev: master device containing the OF node
+ * @compare_of: compare function used for matching components
+ * @m_ops: component master ops to be used
+ *
+ * Parse the platform device OF node and bind all the components associated
+ * with the master. Interface ports are added before the encoders in order to
+ * satisfy their .bind requirements
+ * See Documentation/devicetree/bindings/graph.txt for the bindings.
+ *
+ * Deprecated: Use drm_of_aggregate_probe() instead.
+ *
+ * Returns zero if successful, or one of the standard error codes if it fails.
+ */
+int drm_of_component_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   const struct component_master_ops *m_ops)
+{
+
+	struct component_match *match;
+	int ret;
+
+	ret = _drm_of_component_probe(dev, compare_of, &match);
+	if (ret)
+		return ret;
+
 	return component_master_add_with_match(dev, m_ops, match);
 }
 EXPORT_SYMBOL(drm_of_component_probe);
 
+
+/**
+ * drm_of_aggregate_probe - Generic probe function for a component based aggregate host
+ * @dev: device containing the OF node
+ * @compare_of: compare function used for matching components
+ * @adrv: aggregate driver to be used
+ *
+ * Parse the platform device OF node and bind all the components associated
+ * with the aggregate device. Interface ports are added before the encoders in
+ * order to satisfy their .bind_component requirements
+ * See Documentation/devicetree/bindings/graph.txt for the bindings.
+ *
+ * Returns zero if successful, or one of the standard error codes if it fails.
+ */
+int drm_of_aggregate_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   struct aggregate_driver *adrv)
+{
+	struct component_match *match;
+	int ret;
+
+	ret = _drm_of_component_probe(dev, compare_of, &match);
+	if (ret)
+		return ret;
+
+	return component_aggregate_register(dev, adrv, match);
+}
+EXPORT_SYMBOL(drm_of_aggregate_probe);
+
 /*
  * drm_of_encoder_active_endpoint - return the active encoder endpoint
  * @node: device tree node containing encoder input ports
diff --git a/include/drm/drm_of.h b/include/drm/drm_of.h
index 99f79ac8b4cd..7c7b0d8377a7 100644
--- a/include/drm/drm_of.h
+++ b/include/drm/drm_of.h
@@ -7,6 +7,7 @@
 #include <drm/drm_bridge.h>
 #endif
 
+struct aggregate_driver;
 struct component_master_ops;
 struct component_match;
 struct device;
@@ -40,6 +41,9 @@ void drm_of_component_match_add(struct device *master,
 int drm_of_component_probe(struct device *dev,
 			   int (*compare_of)(struct device *, void *),
 			   const struct component_master_ops *m_ops);
+int drm_of_aggregate_probe(struct device *dev,
+			   int (*compare_of)(struct device *, void *),
+			   struct aggregate_driver *adrv);
 int drm_of_encoder_active_endpoint(struct device_node *node,
 				   struct drm_encoder *encoder,
 				   struct of_endpoint *endpoint);
@@ -79,6 +83,14 @@ drm_of_component_probe(struct device *dev,
 	return -EINVAL;
 }
 
+static inline int
+drm_of_aggregate_probe(struct device *dev,
+		       int (*compare_of)(struct device *, void *),
+		       struct aggregate_driver *adrv)
+{
+	return -EINVAL;
+}
+
 static inline int drm_of_encoder_active_endpoint(struct device_node *node,
 						 struct drm_encoder *encoder,
 						 struct of_endpoint *endpoint)
-- 
https://chromeos.dev


  parent reply	other threads:[~2022-01-27 20:02 UTC|newest]

Thread overview: 94+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-27 20:01 [PATCH v6 00/35] component: Make into an aggregate bus Stephen Boyd
2022-01-27 20:01 ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 01/35] component: Replace most references to 'master' with 'aggregate device' Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-31 13:48   ` Greg Kroah-Hartman
2022-01-31 13:48     ` Greg Kroah-Hartman
2022-01-27 20:01 ` [PATCH v6 02/35] component: Introduce the aggregate bus_type Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-31 13:48   ` Greg Kroah-Hartman
2022-01-31 13:48     ` Greg Kroah-Hartman
2022-01-31 15:15     ` Daniel Vetter
2022-01-31 15:15       ` Daniel Vetter
2022-01-31 15:32       ` Laurent Pinchart
2022-01-31 15:32         ` Laurent Pinchart
2022-01-31 16:34       ` Greg Kroah-Hartman
2022-01-31 16:34         ` Greg Kroah-Hartman
2022-02-08 12:53         ` Daniel Vetter
2022-02-08 12:53           ` Daniel Vetter
2022-02-11  2:04           ` Stephen Boyd
2022-02-11  2:04             ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 03/35] component: Add aggregate_device_parent() for driver use Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 04/35] component: Add {bind,unbind}_component() ops that take aggregate device Stephen Boyd
2022-01-27 20:01   ` [PATCH v6 04/35] component: Add {bind, unbind}_component() " Stephen Boyd
2022-01-27 20:01 ` Stephen Boyd [this message]
2022-01-27 20:01   ` [PATCH v6 05/35] drm/of: Add a drm_of_aggregate_probe() API Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 06/35] drm/msm: Migrate to aggregate driver Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 07/35] drm/komeda: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 08/35] drm/arm/hdlcd: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 09/35] drm/malidp: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 10/35] drm/armada: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 11/35] drm/etnaviv: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 12/35] drm/kirin: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 13/35] drm/exynos: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 14/35] drm/imx: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 15/35] drm/ingenic: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 16/35] drm/mcde: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 17/35] drm/mediatek: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 18/35] drm/meson: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 19/35] drm/omap: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 20/35] drm/rockchip: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 21/35] drm/sti: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 22/35] drm/sun4i: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 23/35] drm/tilcdc: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 24/35] drm/vc4: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 25/35] iommu/mediatek: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-02-10 11:03   ` Yong Wu
2022-02-10 11:03     ` Yong Wu
2022-02-15 17:35     ` Krzysztof Kozlowski
2022-02-15 17:35       ` Krzysztof Kozlowski
2022-01-27 20:01 ` [PATCH v6 26/35] mei: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 27/35] power: supply: ab8500: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 28/35] fbdev: omap2: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 29/35] sound: hdac: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-31  8:18   ` Takashi Iwai
2022-01-31  8:18     ` Takashi Iwai
2022-01-27 20:01 ` [PATCH v6 30/35] ASoC: codecs: wcd938x: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 31/35] drm/sprd: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 32/35] usb: typec: port-mapper: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 33/35] ALSA: hda/realtek: " Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-28 15:31   ` Stefan Binding
2022-01-28 15:31     ` Stefan Binding
2022-01-27 20:01 ` [PATCH v6 34/35] component: Get rid of drm_of_component_probe() Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd
2022-01-27 20:01 ` [PATCH v6 35/35] component: Remove component_master_ops and friends Stephen Boyd
2022-01-27 20:01   ` Stephen Boyd

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220127200141.1295328-6-swboyd@chromium.org \
    --to=swboyd@chromium.org \
    --cc=daniel.vetter@ffwll.ch \
    --cc=dianders@chromium.org \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=freedreno@lists.freedesktop.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=rmk+kernel@arm.linux.org.uk \
    --cc=robdclark@gmail.com \
    --cc=saravanak@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.