summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Holmes <mike.holmes@linaro.org>2016-04-21 21:12:48 -0400
committerMike Holmes <mike.holmes@linaro.org>2016-04-25 19:16:17 -0400
commit3e99f3f09ab1781f5fcc4ba2906629aaa51f417b (patch)
treee495a68f830ae41bbdb955573dac3a95a56a44d4
parent7e2823e9d305b8ec88b4295ede0aa53f6f5f1b99 (diff)
v1.10.0.0auto-csv
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
-rw-r--r--.gitignore2
-rw-r--r--DEPENDANCIES2
-rw-r--r--Makefile18
-rw-r--r--README4
-rw-r--r--latest/.gitignore5
-rw-r--r--latest/Makefile56
-rw-r--r--latest/odp-known-issues.adoc1
-rw-r--r--latest/odp-new-features.adoc1
-rw-r--r--latest/odp-release-notes.adoc55
-rw-r--r--odp-release-notes-v1.9/Makefile11
10 files changed, 149 insertions, 6 deletions
diff --git a/.gitignore b/.gitignore
index fb4ff28..1e2efe9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1 @@
-odp-release-notes.html
+check-odp
diff --git a/DEPENDANCIES b/DEPENDANCIES
new file mode 100644
index 0000000..cf4e88c
--- /dev/null
+++ b/DEPENDANCIES
@@ -0,0 +1,2 @@
+sudo apt install git
+sudo pip install csvkit
diff --git a/Makefile b/Makefile
index 96e0d98..03cd7a0 100644
--- a/Makefile
+++ b/Makefile
@@ -1,11 +1,19 @@
-HTML = $(patsubst %.adoc,%.html,$(shell find -name \*.adoc))
+all: release
-all: $(HTML)
+check-odp:
+ git clone https://git.linaro.org/lng/check-odp.git
clean:
- rm -f $(HTML)
+ rm -rf check-odp
+ $(MAKE) -C latest clean
-%.html: %.adoc
- cd $(<D) && asciidoc $(<F)
+latest/odp-release-notes.html:
+ $(MAKE) -C latest
+
+release: latest/odp-release-notes.html
+ mkdir -p odp-release-notes-vlatest
+ cp latest/libodp-compat_report.html odp-release-notes-vlatest
+ cp latest/odp-release-notes.html odp-release-notes-vlatest
+ cp latest/odp-api-report.txt odp-release-notes-vlatest
.PHONY: all clean
diff --git a/README b/README
new file mode 100644
index 0000000..6a2163f
--- /dev/null
+++ b/README
@@ -0,0 +1,4 @@
+Make releace will generate a latest releace notes between the last tag and
+the latest ofp master
+
+NOTE - WORK IN PROGRESS, read notes in Makefiles
diff --git a/latest/.gitignore b/latest/.gitignore
new file mode 100644
index 0000000..8de212f
--- /dev/null
+++ b/latest/.gitignore
@@ -0,0 +1,5 @@
+odp-bugs-report.csv
+odp-api-report.txt
+odp-bugs-report.csv
+odp-release-notes.html
+libodp-compat_report.html
diff --git a/latest/Makefile b/latest/Makefile
new file mode 100644
index 0000000..8cb95b4
--- /dev/null
+++ b/latest/Makefile
@@ -0,0 +1,56 @@
+
+#bugzill start date/time for listing since last offical relese
+START_DATE = 2016-04-21
+
+#TODO need to use this to get a latest tag and date
+#tag is used to set the master repo to the latest release
+#date can be set from the date/time of this tag to pass to bugzilla
+#git describe --abbrev=0 --tags
+
+#TODO
+#where do we put the src for
+#odp-new-features.ado
+#odp-known-issues.adoc
+#dont really want to check it into latest do we ?
+
+#TODO
+#when there are no bugs you do get a warning
+#asciidoc: WARNING: odp-release-notes.adoc: line 35: [tabledef-default] table is empty
+
+all: odp-release-notes.html
+
+../check-odp:
+ $(MAKE) -C ../ check-odp
+
+odp-bugs-report.csv:
+ +curl "https://bugs.linaro.org/rest/bug?product=OpenDataPlane+-+linux-+generic+reference&creation_time=$(START_DATE)&include_fields=id,summary"| in2csv -k bugs > odp-bugs-report.csv
+
+libodp-compat_report.html: ../check-odp
+ cd ../check-odp; \
+ export COMPARE_BRANCH=next; \
+ ./diff-abi.sh; \
+ cd -
+ mv ../check-odp/publishing/*/*/libodp-compat_report.html .
+
+odp-api-report.txt: ../check-odp
+ cd ../check-odp; \
+ export COMPARE_BRANCH=next; \
+ ./diff-api.sh > odp-api-report.txt; \
+ cd -
+ mv ../check-odp/odp-api-report.txt .
+
+clean:
+ rm -f odp-release-notes.html \
+ odp-bugs-report.csv \
+ compat_report.html \
+ odp-api-report.txt
+
+ rm -rf ../check-odp
+
+odp-release-notes.html: odp-release-notes.adoc odp-bugs-report.csv \
+ odp-new-features.adoc odp-known-issues.adoc \
+ libodp-compat_report.html odp-api-report.txt
+
+ asciidoc $(<F)
+
+.PHONY: all clean
diff --git a/latest/odp-known-issues.adoc b/latest/odp-known-issues.adoc
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/latest/odp-known-issues.adoc
@@ -0,0 +1 @@
+
diff --git a/latest/odp-new-features.adoc b/latest/odp-new-features.adoc
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/latest/odp-new-features.adoc
@@ -0,0 +1 @@
+
diff --git a/latest/odp-release-notes.adoc b/latest/odp-release-notes.adoc
new file mode 100644
index 0000000..0ff4e33
--- /dev/null
+++ b/latest/odp-release-notes.adoc
@@ -0,0 +1,55 @@
+:doctitle: OpenDataPlane (ODP) Release Notes v1.9.0.0
+:description: This document is intended to guide a new application developer +
+in understanding the changes made to the API and ABI when an ODP release is +
+made
+:imagesdir: ../images
+:toc:
+:numbered!:
+
+[abstract]
+== Abstract
+
+This document is intended to guide a new application developer
+in understanding the changes made to the API and ABI when an ODP release is
+made
+
+Further details about ODP may be found at the http://opendataplane.org[ODP]
+home page.
+
+== New Features
+
+include::odp-new-features.adoc[]
+
+== Known Issues
+
+include::odp-known-issues.adoc[]
+
+
+== Resolved Issues in Bugzilla
+The bugs are tracked in a bugzilla instance [1]
+
+.Fixed Bugs
+[format="csv",width="75%",align="center",options="header"]
+|====
+include::odp-bugs-report.csv[]
+|====
+
+== API changes
+The API is defined in doxygen along with the actual definitions in the header files.
+The API is checked via the API Compliance Checker tools in check-odp [3]
+
+This is a work in progress, the tool diffs the actual doxygen documentation of the specification
+but the output format is currently plain diff rather than HTML.
+
+link:odp-api-report.txt[odp-api-report]
+
+== ABI changes
+The ABI is checked via the ABI Compliance Checker (ABICC) [2]
+
+link:libodp-compat_report.html[odp-abi-report]
+
+== References
+
+1. https://bugs.linaro.org/describecomponents.cgi?product=OpenDataPlane%20-%20linux-%20generic%20reference
+2. http://ispras.linuxbase.org/index.php/ABI_compliance_checker
+3. https://git.linaro.org/lng/check-odp.git
diff --git a/odp-release-notes-v1.9/Makefile b/odp-release-notes-v1.9/Makefile
new file mode 100644
index 0000000..96e0d98
--- /dev/null
+++ b/odp-release-notes-v1.9/Makefile
@@ -0,0 +1,11 @@
+HTML = $(patsubst %.adoc,%.html,$(shell find -name \*.adoc))
+
+all: $(HTML)
+
+clean:
+ rm -f $(HTML)
+
+%.html: %.adoc
+ cd $(<D) && asciidoc $(<F)
+
+.PHONY: all clean