doc: Update HDL guide to contain conv-common-gw

3e33038d · Theodor-Adrian Stana · 1f1d93ac · 3e33038d · 1f1d93ac · 3e33038d
Commit 3e33038d authored Sep 25, 2014 by Theodor-Adrian Stana
29 changed files
--- a/doc/hdlg/README
+++ b/doc/hdlg/README
+To work with the template:
+
+1. Copy to location of choice
+2. Run the 'getstarted' script, which will:
+- ask you for the file names (you give it <fname>, NO extensions, please)
+- ask you for the document title
+- change doc.* to <fname>.*
+- add <fname> to the appropriate location in the Makefile
+- change the <fname>.tex file to include <fname>.bib as bibliography
+- change the title in cern-title.tex
+3. Delete the 'getstarted' script
+4. Write your documentation
+5. Type 'make' to create your .pdf documentation file.
+
+NOTE: You need Inkscape to generate .pdf files for the figures:
+sudo apt-get install inkscape
--- a/doc/hdlg/README.txt
+++ b/doc/hdlg/README.txt
-Type 'make' to create your .pdf documentation file.
-
-You need Inkscape to make the documentation files:
-sudo apt-get install inkscape
\ No newline at end of file
--- a/doc/hdlg/cern-title.tex
+++ b/doc/hdlg/cern-title.tex
@@ -9,9 +9,9 @@

 \noindent \rule{\textwidth}{.1cm}

-\hfill Gateware v2.1
+\hfill Gateware v3.0

-\hfill April 8, 2014
+\hfill September 25, 2014

 \vspace*{3cm}


--- a/doc/hdlg/conv-regs.tex
+++ b/doc/hdlg/conv-regs.tex
--- a/doc/hdlg/fig/Makefile
+++ b/doc/hdlg/fig/Makefile
@@ -2,7 +2,6 @@ SRC  = $(wildcard *.svg)
 OBJS = $(SRC:.svg=.pdf)

 all: $(OBJS)
-	echo $(OBJS)

 %.pdf : %.svg
 	inkscape -f $< -A $@

--- a/doc/hdlg/fig/arch.svg
+++ b/doc/hdlg/fig/arch.svg
--- a/doc/hdlg/fig/bicolor-led.svg
+++ b/doc/hdlg/fig/bicolor-led.svg
--- a/doc/hdlg/fig/block-diagram.svg
+++ b/doc/hdlg/fig/block-diagram.svg
--- a/doc/hdlg/fig/clocks.svg
+++ b/doc/hdlg/fig/clocks.svg
--- a/doc/hdlg/fig/declarative.svg
+++ b/doc/hdlg/fig/declarative.svg
--- a/doc/hdlg/fig/body.svg
+++ b/doc/hdlg/fig/body.svg
--- a/doc/hdlg/fig/hdl-bd.svg
+++ b/doc/hdlg/fig/hdl-bd.svg
--- a/doc/hdlg/fig/line-inp.svg
+++ b/doc/hdlg/fig/line-inp.svg
--- a/doc/hdlg/fig/man-trig-fsm.svg
+++ b/doc/hdlg/fig/man-trig-fsm.svg
--- a/doc/hdlg/fig/no-sig-detect.svg
+++ b/doc/hdlg/fig/no-sig-detect.svg
--- a/doc/hdlg/fig/pulse-cnt.svg
+++ b/doc/hdlg/fig/pulse-cnt.svg
--- a/doc/hdlg/fig/pulse-gen.svg
+++ b/doc/hdlg/fig/pulse-gen.svg
--- a/doc/hdlg/fig/pulse-led.svg
+++ b/doc/hdlg/fig/pulse-led.svg
--- a/doc/hdlg/fig/pulse-rep.svg
+++ b/doc/hdlg/fig/pulse-rep.svg
--- a/doc/hdlg/fig/timetag-ring-buf.svg
+++ b/doc/hdlg/fig/timetag-ring-buf.svg
--- a/doc/hdlg/fig/rtm-detect.svg
+++ b/doc/hdlg/fig/rtm-detect.svg
--- a/doc/hdlg/fig/switches.svg
+++ b/doc/hdlg/fig/switches.svg
--- a/doc/hdlg/fig/timetag-arch.svg
+++ b/doc/hdlg/fig/timetag-arch.svg
--- a/doc/hdlg/fig/timetag-core.svg
+++ b/doc/hdlg/fig/timetag-core.svg
--- a/doc/hdlg/fig/ttl-inp.svg
+++ b/doc/hdlg/fig/ttl-inp.svg
--- a/doc/hdlg/fig/ttl-outp.svg
+++ b/doc/hdlg/fig/ttl-outp.svg
--- a/doc/hdlg/hdlg-conv-ttl-blo.bib
+++ b/doc/hdlg/hdlg-conv-ttl-blo.bib
--- a/doc/hdlg/hdlg-conv-ttl-blo.tex
+++ b/doc/hdlg/hdlg-conv-ttl-blo.tex
--- a/doc/hdlg/multiboot-regs.tex
+++ b/doc/hdlg/multiboot-regs.tex