* [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests
@ 2024-10-20 21:39 Jakob Kirsch via Guix-patches via
2024-10-20 21:47 ` [bug#73918] [PATCH v2 " Jakob Kirsch via Guix-patches via
` (7 more replies)
0 siblings, 8 replies; 14+ messages in thread
From: Jakob Kirsch via Guix-patches via @ 2024-10-20 21:39 UTC (permalink / raw)
To: 73918; +Cc: Jakob Kirsch
* gnu/packages/fpga.scm (iverilog): [inputs]: Add zlib.
Change-Id: I961bf73b17f96a5891232a8646bc04581dfb8bfc
---
gnu/packages/fpga.scm | 1 +
1 file changed, 1 insertion(+)
diff --git a/gnu/packages/fpga.scm b/gnu/packages/fpga.scm
index 545ec3482d..153d17d1f3 100644
--- a/gnu/packages/fpga.scm
+++ b/gnu/packages/fpga.scm
@@ -125,6 +125,7 @@ (define-public iverilog
#:make-flags #~(list (string-append "PREFIX="
#$output))
#:bootstrap-scripts #~(list "autoconf.sh")))
+ (inputs (list zlib))
(native-inputs (list autoconf bison flex gperf))
(home-page "https://steveicarus.github.io/iverilog")
(synopsis "FPGA Verilog simulation and synthesis tool")
base-commit: 5703914e93d81ac6037240582abe899282e78f15
--
2.46.0
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH v2 1/2] gnu: iverilog: Fix yosys tests
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
@ 2024-10-20 21:47 ` Jakob Kirsch via Guix-patches via
2024-10-20 21:48 ` [bug#73918] [PATCH v2 2/2] gnu: yosys: Update to 0.46 Jakob Kirsch via Guix-patches via
2024-10-26 16:56 ` [bug#73918] [PATCH] " Denis 'GNUtoo' Carikli
` (6 subsequent siblings)
7 siblings, 1 reply; 14+ messages in thread
From: Jakob Kirsch via Guix-patches via @ 2024-10-20 21:47 UTC (permalink / raw)
To: 73918; +Cc: Jakob Kirsch, Jakob Kirsch
* gnu/packages/fpga.scm (iverilog): [inputs]: Add zlib.
Change-Id: I961bf73b17f96a5891232a8646bc04581dfb8bfc
---
gnu/packages/fpga.scm | 1 +
1 file changed, 1 insertion(+)
diff --git a/gnu/packages/fpga.scm b/gnu/packages/fpga.scm
index 545ec3482d..153d17d1f3 100644
--- a/gnu/packages/fpga.scm
+++ b/gnu/packages/fpga.scm
@@ -125,6 +125,7 @@ (define-public iverilog
#:make-flags #~(list (string-append "PREFIX="
#$output))
#:bootstrap-scripts #~(list "autoconf.sh")))
+ (inputs (list zlib))
(native-inputs (list autoconf bison flex gperf))
(home-page "https://steveicarus.github.io/iverilog")
(synopsis "FPGA Verilog simulation and synthesis tool")
base-commit: 5703914e93d81ac6037240582abe899282e78f15
--
2.46.0
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH v2 2/2] gnu: yosys: Update to 0.46.
2024-10-20 21:47 ` [bug#73918] [PATCH v2 " Jakob Kirsch via Guix-patches via
@ 2024-10-20 21:48 ` Jakob Kirsch via Guix-patches via
0 siblings, 0 replies; 14+ messages in thread
From: Jakob Kirsch via Guix-patches via @ 2024-10-20 21:48 UTC (permalink / raw)
To: 73918; +Cc: Jakob Kirsch, Jakob Kirsch
* gnu/packages/fpga.scm (yosys): Update to 0.46.
Change-Id: Ibdd4c02155ace62bf50ff9b7bb605edc21698c2a
---
gnu/packages/fpga.scm | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/fpga.scm b/gnu/packages/fpga.scm
index 153d17d1f3..83e81bfc50 100644
--- a/gnu/packages/fpga.scm
+++ b/gnu/packages/fpga.scm
@@ -8,6 +8,7 @@
;;; Copyright © 2022 Christian Gelinek <cgelinek@radlogic.com.au>
;;; Copyright © 2022 jgart <jgart@dismail.de>
;;; Copyright © 2024 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2024 Jakob Kirsch <jakob.kirsch@web.de>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -149,15 +150,15 @@ (define-public iverilog
(define-public yosys
(package
(name "yosys")
- (version "0.26")
+ (version "0.46")
(source (origin
(method git-fetch)
(uri (git-reference
(url "https://github.com/YosysHQ/yosys")
- (commit (string-append "yosys-" version))))
+ (commit version)))
(sha256
(base32
- "0s79ljgbcfkm7l9km7dcvlz4mnx38nbyxppscvh5il5lw07n45gx"))
+ "1zj7vbpy6v1wn4p5cjs4hdjd467a1j1aj2qhs148bl2s6mzq3p86"))
(file-name (git-file-name name version))))
(build-system gnu-build-system)
(arguments
--
2.46.0
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH] gnu: yosys: Update to 0.46.
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
2024-10-20 21:47 ` [bug#73918] [PATCH v2 " Jakob Kirsch via Guix-patches via
@ 2024-10-26 16:56 ` Denis 'GNUtoo' Carikli
2024-10-31 16:38 ` Jakob Kirsch via Guix-patches via
` (5 subsequent siblings)
7 siblings, 0 replies; 14+ messages in thread
From: Denis 'GNUtoo' Carikli @ 2024-10-26 16:56 UTC (permalink / raw)
To: 73918
[-- Attachment #1: Type: text/plain, Size: 704 bytes --]
Hi,
Thanks a lot for the patches.
Note that I'm not a Guix committer nor maintainer.
Also I'm not familiar with best practice for commit messages within the
Guix projects but other projects that care a lot about code quality
tend to indicate the commit that broke something in the commit message.
For instance in Linux we have commits like that:
> This was broken by commit 16aac5ad1fa9 ("ovl: support encoding
> non-decodable file handles"), which didn't take the lower-only
> configuration into account.
That would simplify the review as here a reviewer will probably need to
look into what broke yosys to verify if your fix is the best possible
fix (it probably is).
Denis.
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH] gnu: yosys: Update to 0.46.
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
2024-10-20 21:47 ` [bug#73918] [PATCH v2 " Jakob Kirsch via Guix-patches via
2024-10-26 16:56 ` [bug#73918] [PATCH] " Denis 'GNUtoo' Carikli
@ 2024-10-31 16:38 ` Jakob Kirsch via Guix-patches via
2024-11-01 7:27 ` [bug#73918] (no subject) Cayetano Santos via Guix-patches via
` (4 subsequent siblings)
7 siblings, 0 replies; 14+ messages in thread
From: Jakob Kirsch via Guix-patches via @ 2024-10-31 16:38 UTC (permalink / raw)
To: 73918
Thank you for the feedback, the commit that broke yosys was b32f8bc9da74158330cebdbcb481d41e1be6d1ce when iverilog was updated to 12.0
iverilog needs zlib as an input for a feature that yosys requires.
I fixed that with the one patch and also updated yosys in the process because it's kinda outdated.
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] (no subject)
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
` (2 preceding siblings ...)
2024-10-31 16:38 ` Jakob Kirsch via Guix-patches via
@ 2024-11-01 7:27 ` Cayetano Santos via Guix-patches via
2024-11-02 8:42 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
` (3 subsequent siblings)
7 siblings, 0 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-01 7:27 UTC (permalink / raw)
To: 73918
As the author of the faulty commit, blindly removing zlib, I can
confirm: this patch fixes the test issues with yosys and builds yosys
0.46. Thanks !
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] QA review for 73918
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
` (3 preceding siblings ...)
2024-11-01 7:27 ` [bug#73918] (no subject) Cayetano Santos via Guix-patches via
@ 2024-11-02 8:42 ` Cayetano Santos via Guix-patches via
2024-11-03 16:27 ` [bug#73918] [PATCH] gnu: yosys: Update to 0.46 Denis 'GNUtoo' Carikli
` (2 subsequent siblings)
7 siblings, 0 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-02 8:42 UTC (permalink / raw)
To: control, 73918
user guix
usertag 73918 + waiting-on-contributor
thanks
Guix QA review form submission:
- There is a missing dot at the end of commit message in v2 1/2
- If you send a v3, it’s better to include a link to the commit
introducing the error you’re fixing in the body of the commit message
https://git.savannah.gnu.org/cgit/guix.git/commit/?id=b32f8bc9da
- [linter yosys] : "bash-minimal" should be in 'inputs' when
'wrap-program' is used, you’ll need also
#:use-module (gnu packages bash)
Other than this, it builds and executes with no issue
Thanks for fixing the error !
Items marked as checked: Commit messages, Package builds, Lint warnings
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH] gnu: yosys: Update to 0.46.
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
` (4 preceding siblings ...)
2024-11-02 8:42 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
@ 2024-11-03 16:27 ` Denis 'GNUtoo' Carikli
2024-11-04 10:56 ` Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 0/2] Minor corrections to v2 Cayetano Santos via Guix-patches via
2024-11-09 19:22 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
7 siblings, 1 reply; 14+ messages in thread
From: Denis 'GNUtoo' Carikli @ 2024-11-03 16:27 UTC (permalink / raw)
To: 73918
[-- Attachment #1: Type: text/plain, Size: 1350 bytes --]
Hi,
> Thank you for the feedback, the commit that broke yosys was
> b32f8bc9da74158330cebdbcb481d41e1be6d1ce when iverilog was updated to
> 12.0
Thanks a lot for the information. I also have yosys that fails because
of the missing zlib but it wasn't clear why it became needed out of the
blue. I've not build-tested the patch yet though.
The commit b32f8bc9da74158330cebdbcb481d41e1be6d1ce ("gnu: iverilog:
Update to 12.0."), also brings more questions. In it we have:
- (native-inputs
- (list flex bison ghostscript zlib)) ; ps2pdf
+ (native-inputs (list autoconf bison flex gperf))
So do we also need Ghostscript ? Though if it builds and run fine
without Ghostscript maybe ghostscript got removed because it wasn't
useful?
Also would it help if I package some functional test(s) for the FPGA
toolchain? Personally I found that it made it easier to test the
packages when I maintained them for Parabola.
Though the "functional test" I have is just the FOMU workshop code that
I modified to blink blue instead of other colors:
https://git.parabola.nu/fpga/fomu-verilog-blue-blink.git/
The downside is that tests like that are specific to an FPGA model so
I'm unsure if this is a good idea or not.
Also note that I don't know FPGAs well. I just got one to maintain some
Parabola packages.
Denis.
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH] gnu: yosys: Update to 0.46.
2024-11-03 16:27 ` [bug#73918] [PATCH] gnu: yosys: Update to 0.46 Denis 'GNUtoo' Carikli
@ 2024-11-04 10:56 ` Cayetano Santos via Guix-patches via
0 siblings, 0 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-04 10:56 UTC (permalink / raw)
To: gnutoo; +Cc: 73918
> I've not build-tested the patch yet though.
I have, It works like a charm.
> So do we also need Ghostscript ? Though if it builds and run fine
> without Ghostscript maybe ghostscript got removed because it wasn't
> useful?
I got removed (by me) because there is no mention to in the instructions
for installing iverilog (see readme), same as zlib. It turns out that
the later is important, though.
To that purpose, the command (that I just discovered)
guix refresh --list-dependent iverilog
outputs a list of packages (yosys here) which depends on iverilog, and
need to be rebuild upon every new modification in iverilog. If I had run
it, I would have discovered the issue on time. My bad.
In addition, having a look at the history of latest iverilog related
commits is not a bad idea.
https://git.savannah.gnu.org/cgit/guix.git/commit/?id=9f82d1f1c0
C.
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH v3 0/2] Minor corrections to v2
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
` (5 preceding siblings ...)
2024-11-03 16:27 ` [bug#73918] [PATCH] gnu: yosys: Update to 0.46 Denis 'GNUtoo' Carikli
@ 2024-11-09 19:08 ` Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 1/2] gnu: iverilog: Fix yosys tests Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 2/2] gnu: yosys: Update to 0.46 Cayetano Santos via Guix-patches via
2024-11-09 19:22 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
7 siblings, 2 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-09 19:08 UTC (permalink / raw)
To: 73918; +Cc: Cayetano Santos
Add modifications neeeded as for previous QA review:
. missing dot at the end of commit message in v2 1/2
. include a link in the commit message to the commit introducing the error this patch fixes
https://git.savannah.gnu.org/cgit/guix.git/commit/?id=b32f8bc9da
. "bash-minimal" should be in 'inputs' when 'wrap-program' is used
Cayetano Santos (2):
gnu: iverilog: Fix yosys tests.
gnu: yosys: Update to 0.46.
gnu/packages/fpga.scm | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
--
2.46.0
^ permalink raw reply [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH v3 1/2] gnu: iverilog: Fix yosys tests.
2024-11-09 19:08 ` [bug#73918] [PATCH v3 0/2] Minor corrections to v2 Cayetano Santos via Guix-patches via
@ 2024-11-09 19:08 ` Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 2/2] gnu: yosys: Update to 0.46 Cayetano Santos via Guix-patches via
1 sibling, 0 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-09 19:08 UTC (permalink / raw)
To: 73918; +Cc: Cayetano Santos
Change-Id: I262db5db43527a3a2a1753163f7b9a4104f7e895
Fixes issue introduced in
https://git.savannah.gnu.org/cgit/guix.git/commit/?id=b32f8bc9da
which removes zlib. This produces errors when building yosys.
Change-Id: I5b817d176430a0e717597482883d7e806c4552ab
---
See explanation in commit message.
gnu/packages/fpga.scm | 1 +
1 file changed, 1 insertion(+)
diff --git a/gnu/packages/fpga.scm b/gnu/packages/fpga.scm
index c812ed3b7e..ea08aed04c 100644
--- a/gnu/packages/fpga.scm
+++ b/gnu/packages/fpga.scm
@@ -125,7 +125,7 @@ (define-public iverilog
#:make-flags #~(list (string-append "PREFIX="
#$output))
#:bootstrap-scripts #~(list "autoconf.sh")))
+ (inputs (list zlib))
(native-inputs (list autoconf bison flex gperf))
(home-page "https://steveicarus.github.io/iverilog")
(synopsis "FPGA Verilog simulation and synthesis tool")
--
2.46.0
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [bug#73918] [PATCH v3 2/2] gnu: yosys: Update to 0.46.
2024-11-09 19:08 ` [bug#73918] [PATCH v3 0/2] Minor corrections to v2 Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 1/2] gnu: iverilog: Fix yosys tests Cayetano Santos via Guix-patches via
@ 2024-11-09 19:08 ` Cayetano Santos via Guix-patches via
2024-11-12 11:40 ` bug#73918: " Maxim Cournoyer
1 sibling, 1 reply; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-09 19:08 UTC (permalink / raw)
To: 73918; +Cc: Cayetano Santos
* gnu/packages/fpga.scm (yosys): Update to 0.46.
Change-Id: Id980679e6576b27429611f8399eff2185e57d684
---
gnu/packages/fpga.scm | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/fpga.scm b/gnu/packages/fpga.scm
index ea08aed04c..be3e57ffb4 100644
--- a/gnu/packages/fpga.scm
+++ b/gnu/packages/fpga.scm
@@ -8,6 +8,7 @@
;;; Copyright © 2022 Christian Gelinek <cgelinek@radlogic.com.au>
;;; Copyright © 2022 jgart <jgart@dismail.de>
;;; Copyright © 2024 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2024 Jakob Kirsch <jakob.kirsch@web.de>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -38,6 +39,7 @@ (define-module (gnu packages fpga)
#:use-module (gnu packages autotools)
#:use-module (gnu packages algebra)
#:use-module (gnu packages base)
+ #:use-module (gnu packages bash)
#:use-module (gnu packages bison)
#:use-module (gnu packages boost)
#:use-module (gnu packages check)
@@ -149,15 +151,15 @@ (define-public iverilog
(define-public yosys
(package
(name "yosys")
- (version "0.26")
+ (version "0.46")
(source (origin
(method git-fetch)
(uri (git-reference
(url "https://github.com/YosysHQ/yosys")
- (commit (string-append "yosys-" version))))
+ (commit version)))
(sha256
(base32
- "0s79ljgbcfkm7l9km7dcvlz4mnx38nbyxppscvh5il5lw07n45gx"))
+ "1zj7vbpy6v1wn4p5cjs4hdjd467a1j1aj2qhs148bl2s6mzq3p86"))
(file-name (git-file-name name version))))
(build-system gnu-build-system)
(arguments
@@ -216,6 +218,7 @@ (define-public yosys
tcl)) ; tclsh for the tests
(inputs
(list abc
+ bash-minimal
graphviz
gtkwave
libffi
--
2.46.0
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [bug#73918] QA review for 73918
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
` (6 preceding siblings ...)
2024-11-09 19:08 ` [bug#73918] [PATCH v3 0/2] Minor corrections to v2 Cayetano Santos via Guix-patches via
@ 2024-11-09 19:22 ` Cayetano Santos via Guix-patches via
7 siblings, 0 replies; 14+ messages in thread
From: Cayetano Santos via Guix-patches via @ 2024-11-09 19:22 UTC (permalink / raw)
To: control, 73918
user guix
usertag 73918 + reviewed-looks-good
thanks
Guix QA review form submission:
Items marked as checked:
- Commit messages
- Package builds
- Lint warnings
- Package tests
- Package style
- List dependent packages build
^ permalink raw reply [flat|nested] 14+ messages in thread
* bug#73918: [PATCH v3 2/2] gnu: yosys: Update to 0.46.
2024-11-09 19:08 ` [bug#73918] [PATCH v3 2/2] gnu: yosys: Update to 0.46 Cayetano Santos via Guix-patches via
@ 2024-11-12 11:40 ` Maxim Cournoyer
0 siblings, 0 replies; 14+ messages in thread
From: Maxim Cournoyer @ 2024-11-12 11:40 UTC (permalink / raw)
To: Cayetano Santos; +Cc: 73918-done, Jakob Kirsch
Hello,
Cayetano Santos <csantosb@inventati.org> writes:
> * gnu/packages/fpga.scm (yosys): Update to 0.46.
>
> Change-Id: Id980679e6576b27429611f8399eff2185e57d684
Merged this as 4bfe5fc584 and followed with an update to 0.47.
Closing!
--
Thanks,
Maxim
^ permalink raw reply [flat|nested] 14+ messages in thread
end of thread, other threads:[~2024-11-12 11:42 UTC | newest]
Thread overview: 14+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-10-20 21:39 [bug#73918] [PATCH v1 1/2] gnu: iverilog: Fix yosys tests Jakob Kirsch via Guix-patches via
2024-10-20 21:47 ` [bug#73918] [PATCH v2 " Jakob Kirsch via Guix-patches via
2024-10-20 21:48 ` [bug#73918] [PATCH v2 2/2] gnu: yosys: Update to 0.46 Jakob Kirsch via Guix-patches via
2024-10-26 16:56 ` [bug#73918] [PATCH] " Denis 'GNUtoo' Carikli
2024-10-31 16:38 ` Jakob Kirsch via Guix-patches via
2024-11-01 7:27 ` [bug#73918] (no subject) Cayetano Santos via Guix-patches via
2024-11-02 8:42 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
2024-11-03 16:27 ` [bug#73918] [PATCH] gnu: yosys: Update to 0.46 Denis 'GNUtoo' Carikli
2024-11-04 10:56 ` Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 0/2] Minor corrections to v2 Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 1/2] gnu: iverilog: Fix yosys tests Cayetano Santos via Guix-patches via
2024-11-09 19:08 ` [bug#73918] [PATCH v3 2/2] gnu: yosys: Update to 0.46 Cayetano Santos via Guix-patches via
2024-11-12 11:40 ` bug#73918: " Maxim Cournoyer
2024-11-09 19:22 ` [bug#73918] QA review for 73918 Cayetano Santos via Guix-patches via
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
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.