add cesar

[libreriscv.git] / HDL_workflow / devscripts.mdwn

diff --git a/HDL_workflow/devscripts.mdwn b/HDL_workflow/devscripts.mdwn
index c01c003a1bc1c5c9b909d1c2aea5fd3befda1365..2ec96bef61e564ee2e4cf551f8639a40cd7dab08 100644 (file)
--- a/HDL_workflow/devscripts.mdwn
+++ b/HDL_workflow/devscripts.mdwn
@@ -12,25 +12,35 @@ the dev-env-setup repository is cloned twice, once to get the chroot
 script and a second time to use scripts *inside* the chroot. Feel free
 to simply copy the repository into the chroot to save bandwidth.
 
+**no you do not need to blow away your system and install debian 10 native**
+you can e.g. use debian/11 at the "host" level and some people have managed
+to use archlinux but you are **on your own if you do so, and should only
+consider the option of using your own preferred host OS if you are an
+advanced expert**.  We do **NOT** provide "personal end-user support"
+for Host OS problems.
+
 Note: these scripts assume that you are using debian/10 and that you
 understand and accept why we have standardised on that as an OS
 (reproduceability and minimising "support").  If you use anything
 different it risks creating non-reproducible HDL. It's not about
 "what's the favurite OS", it's about making sure that two developers
-can produce the **exact** same GDS-II files.
+can produce the **exact** same GDS-II files, which is kinda important
+if you are going to drop USD 16 million on 7nm Mask Charges.
 
     $ git clone https://git.libre-soc.org/git/dev-env-setup.git
     $ cd dev-env-setup
     $ sudo bash
+    (optional: # export CHROOT_DEBIAN_MIRROR=http://ftp.<mirror>.debian.org/debian)
     # ./mk-deb-chroot libresoc
+    # ./cp-scripts-to-chroot libresoc # copies dev-env-setup to chroot
     # exit
     $ schroot -c libresoc
-    (libresoc)$ git clone https://git.libre-soc.org/git/dev-env-setup.git
-    (libresoc)$ cd dev-env-setup
     (libresoc)$ sudo bash
     (libresoc)# ./install-hdl-apt-reqs
+    (libresoc)# ./hdl-tools-yosys
     (libresoc)# ./hdl-dev-repos
     (libresoc)# ./ppc64-gdb-gcc           # needed for compiling unit tests
+    (libresoc)# ./binutils-gdb-install    # needed for binutils-svp64
     (libresoc)# exit
     (libresoc)$
 
@@ -43,8 +53,21 @@ There is an accompanying walkthrough video which goes through the above
 <https://m.youtube.com/watch?v=1-4eJKTNrEk> and includes running some
 unit tests, explaining some of the background, and also files some bugs.
 
+**You are now done, you need only read the rest below if interested
+to see how we made the above scripts**
+
+=======
+=======
+=======
+=======
+=======
+
 # Notes about Script "mk-deb-chroot"
 
+This section is developer-notes **only** it documents the
+process by which mk-deb-chroot was established and explains
+its decisions and effect.
+
 The script sets up an schroot debootstrap jail with debian 10. 
 This chroot can then be used for nmigen, coriolis, or any other development. 
 These instructions are based on information taken from here:
@@ -131,3 +154,4 @@ as *root*, you run this:
 and you will see this as a result:
 
     (libresoc)lkcl@fizzy:~#
+