Tidy up of source tree for new Git tree layout.
authorTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Mon, 11 May 2020 10:48:10 +0000 (11:48 +0100)
committerTerry Barnaby <terry.barnaby@beam.beam.ltd.uk>
Mon, 11 May 2020 10:48:10 +0000 (11:48 +0100)
.gitignore [new file with mode: 0644]
Config.mk
Makefile
doc/Readme.pdf
docsrc/Makefile
docsrc/fpga_doxygen.dox
docsrc/fpga_overview.dox
docsrc/host_doxygen.dox
docsrc/host_overview.dox

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..f6ad210
--- /dev/null
@@ -0,0 +1,6 @@
+doc/DuneNvmeStorageDesign.pdf
+doc/DuneNvmeStorageManual.pdf
+doc/DuneNvmeStorageProject.pdf
+doc/fpga/
+doc/host/
+docsrc/.configured
index 3f1691806bf68b54bcf6b4f94b98b162c71bb02c..5f8f21fef4f78fd3c76a970e6addb2510dc99e9f 100644 (file)
--- a/Config.mk
+++ b/Config.mk
@@ -4,5 +4,5 @@
 ################################################################################
 #
 PROJECT                = DuneNvme
-VERSION                = 0.1.1
-DOCDIR         ?= ${TOP}/doc/${PROJECT}
+VERSION                = 0.3.1
+DOCDIR         ?= 
index 15493c54e726d3cbf95ac40dde34203b424d975c..cf54e6a808cabe928269acea9eba903874a4c949 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -3,15 +3,19 @@
 #      T.Barnaby,      Beam Ltd,       2020-02-18
 ################################################################################
 #
-TOP    = ../..
 include Config.mk
 
+# Fedora RPM packages needed
+PACKAGES       = "ghdl gtkwave"
+PACKAGES       += "texlive-scheme-medium texlive-hanging texlive-stackengine texlive-etoc texlive-newunicodechar"
+
 .PHONY:        release
 
 all:
-       
+       make -C vivado
+       make -C test
 
-install:
+install: all
 
 clean:
        make -C vivado clean
@@ -24,12 +28,39 @@ distclean: clean
        make -C docsrc distclean
        make -C test distclean
        
-release:
+release: all
        mkdir -p release
        cp vivado/*.runs/impl_1/*.bit release/${PROJECT}-${VERSION}.bit
+       cp test/test-nvme release/test-nvme-${VERSION}
 
 docs:
        make -C docsrc
 
-packages:
-       dnf install texlive-scheme-medium texlive-hanging texlive-stackengine texlive-etoc texlive-newunicodechar
+installPackages:
+       dnf install ${PACKAGES}
+
+
+################################################################################
+#      Git project Management
+################################################################################
+#
+gitPush:
+       git push master
+       git push --tags
+
+gitListReleases:
+       git tag
+
+gitCommit:
+       git commit -a
+
+gitRelease:
+       git tag release-${VERSION}
+       git push master
+       git push --tags
+
+gitDiff:
+       git diff
+
+gitId:
+       git rev-parse HEAD
index 51ae7cb181a934e722337f6cf5bd22ccb71f2f4f..dc67d38bb359f83e41cff1bded8ec54eed8c2e1e 100644 (file)
Binary files a/doc/Readme.pdf and b/doc/Readme.pdf differ
index f6952cf0124a467592bea067556159628f77515d..21adffb68122f4b3d37645aa572c6e38a2c6b95a 100644 (file)
@@ -3,9 +3,10 @@
 #      T.Barnaby,      Beam Ltd,       2020-02-18
 ################################################################################
 #
-TOP    = ../../..
 include ../Config.mk
 
+DateNow = $(shell date -I)
+
 .PHONY:        config release
 
 all:   config docs
@@ -16,14 +17,18 @@ config: .configured
        sed -i "s/PROJECT_NUMBER.*/PROJECT_NUMBER\t\t= ${VERSION}/g" fpga_doxygen.dox
        sed -i "s/PROJECT_NUMBER.*/PROJECT_NUMBER\t\t= ${VERSION}/g" host_doxygen.dox
        sed -i "s/\\\version.*/\\\version ${VERSION}/g" fpga_overview.dox
+       sed -i "s/\\\date.*/\\\date ${DateNow}/g" fpga_overview.dox
        sed -i "s/\\\version.*/\\\version ${VERSION}/g" host_overview.dox
+       sed -i "s/\\\date.*/\\\date ${DateNow}/g" host_overview.dox
        touch .configured
 
 install:
-       mkdir -p ${DOCDIR}/host ${DOCDIR}/fpga
-       cp -a ../doc/host/html ${DOCDIR}/host
-       cp -a ../doc/fpga/html ${DOCDIR}/fpga
-       cp -a ../doc/*.pdf ${DOCDIR}
+       @if [ "${DOCDIR}" != "" ]; then \
+               mkdir -p ${DOCDIR}/host ${DOCDIR}/fpga; \
+               cp -a ../doc/host/html ${DOCDIR}/host; \
+               cp -a ../doc/fpga/html ${DOCDIR}/fpga; \
+               cp -a ../doc/*.pdf ${DOCDIR}; \
+       fi;
 
 clean:
 
@@ -37,6 +42,9 @@ docs:
        doxygen host_doxygen.dox
        doxygen fpga_doxygen.dox
        soffice --headless --convert-to pdf --outdir ../doc Readme.odt
+       soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageManual.odt
+       soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageDesign.odt
+       soffice --headless --convert-to pdf --outdir ../doc DuneNvmeStorageProject.odt
 
 docspdf: docs
        (cd ../doc/host/latex; make)
index 658dfd1052fc1403d2d87fce73a3e6e3e8a94fcd..356abad0d25ca1c71d27c07cbc3017b39d152d31 100644 (file)
@@ -1,7 +1,7 @@
 # Doxyfile 1.8.15
 
 PROJECT_NAME           = "DuneNvme"
-PROJECT_NUMBER         = 0.1.1
+PROJECT_NUMBER         = 0.3.1
 PROJECT_BRIEF          = "This is a simple NVMe test environment that allows experimentation with the low level PCIe NVMe interfaces as available on a Xilinx FPGA environment."
 PROJECT_LOGO           =
 INPUT                  = fpga_overview.dox ../src
index b7d25b5fd48f088ed75b5ad12766ba227616bc41..8620c15123a5bbddcb7485050f1f1ea2ddab2de1 100644 (file)
@@ -4,8 +4,8 @@
  */
 /**
 \author Dr Terry Barnaby
-\version 0.1.1
-\date 2020-04-26
+\version 0.3.1
+\date 2020-05-11
 
 \mainpage
 
index 0276e39a7adefe83537b59d0635fa00d5bd72afd..1bba80c19558aa95fcd6521b0cccaf56c6d7359b 100644 (file)
@@ -1,7 +1,7 @@
 # Doxyfile 1.8.15
 
 PROJECT_NAME           = "DuneNvme"
-PROJECT_NUMBER         = 0.1.1
+PROJECT_NUMBER         = 0.3.1
 PROJECT_BRIEF          = "This is a simple NVMe test environment that allows experimentation with the low level PCIe NVMe interfaces as available on a Xilinx FPGA environment."
 PROJECT_LOGO           =
 INPUT                  = host_overview.dox ../test
index d108e2bd0ebcc7fb9805081cd7dfbf40c86775ef..a35b3f26a14aab1fbe9c31d6f3107db95b5f6d5e 100644 (file)
@@ -4,8 +4,8 @@
  */
 /**
 \author Dr Terry Barnaby
-\version 0.1.1
-\date 2020-04-26
+\version 0.3.1
+\date 2020-05-11
 
 \mainpage