MCOL-2180 Update UDAF docs

utils/udfsdk/docs/build/Makefile

@@ -0,0 +1,68 @@
+# Makefile for Sphinx LaTeX output
+
+ALLDOCS = $(basename $(wildcard *.tex))
+ALLPDF = $(addsuffix .pdf,$(ALLDOCS))
+ALLDVI = $(addsuffix .dvi,$(ALLDOCS))
+ALLXDV =
+ALLPS  = $(addsuffix .ps,$(ALLDOCS))
+ALLIMGS = $(wildcard *.png *.gif *.jpg *.jpeg)
+
+# Prefix for archive names
+ARCHIVEPREFIX =
+# Additional LaTeX options (passed via variables in latexmkrc/latexmkjarc file)
+export LATEXOPTS =
+# Additional latexmk options
+LATEXMKOPTS =
+# format: pdf or dvi (used only by archive targets)
+FMT = pdf
+
+LATEX = latexmk -dvi
+PDFLATEX = latexmk -pdf -dvi- -ps-
+
+
+%.png %.gif %.jpg %.jpeg: FORCE_MAKE
+	extractbb '$@'
+
+%.dvi: %.tex FORCE_MAKE
+	$(LATEX) $(LATEXMKOPTS) '$<'
+
+%.ps: %.dvi
+	dvips '$<'
+
+%.pdf: %.tex FORCE_MAKE
+	$(PDFLATEX) $(LATEXMKOPTS) '$<'
+
+all: $(ALLPDF)
+
+all-dvi: $(ALLDVI)
+
+all-ps: $(ALLPS)
+
+all-pdf: $(ALLPDF)
+
+zip: all-$(FMT)
+	mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+	cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+	zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT)
+	rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+tar: all-$(FMT)
+	mkdir $(ARCHIVEPREFIX)docs-$(FMT)
+	cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT)
+	tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT)
+	rm -r $(ARCHIVEPREFIX)docs-$(FMT)
+
+gz: tar
+	gzip -9 < $(ARCHIVEPREFIX)docs-$(FMT).tar > $(ARCHIVEPREFIX)docs-$(FMT).tar.gz
+
+bz2: tar
+	bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+
+xz: tar
+	xz -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar
+
+clean:
+	rm -f *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla *.ps *.tar *.tar.gz *.tar.bz2 *.tar.xz $(ALLPDF) $(ALLDVI) $(ALLXDV) *.fls *.fdb_latexmk
+
+.PHONY: all all-pdf all-dvi all-ps clean zip tar gz bz2 xz
+.PHONY: FORCE_MAKE

utils/udfsdk/docs/source/changelog.rst

@@ -5,5 +5,6 @@ Version History
 | Version | Date       | Changes                     |
 +=========+============+=============================+
 | 1.1.0α  | 2017-08-25 | - First alpha release       |
++---------+------------+-----------------------------+
 | 1.2.0α  | 2016-05-18 | - Add multi parm support    |
 +---------+------------+-----------------------------+

utils/udfsdk/docs/source/conf.py

@@ -49,7 +49,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'UDAF'
-copyright = u'2017, MariaDB Corporation'
+copyright = u'2019, MariaDB Corporation'
 author = u'MariaDB Corporation'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -57,9 +57,9 @@ author = u'MariaDB Corporation'
 # built documents.
 #
 # The short X.Y version.
-version = u'1.1'
+version = u'1.2'
 # The full version, including alpha/beta/rc tags.
-release = u'1.1'
+release = u'1.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

utils/udfsdk/docs/source/reference/UDAFMap.rst

@@ -34,3 +34,24 @@ The UDAFMap is where we tell the system about our function. For Columnstore 1.2,
     return fm;
  }
 
+An alternative method added for 1.2 is to put the following in your .cpp file.
+replace "median" with the name of your function:
+
+::
+
+ class Add_median_ToUDAFMap
+ {
+ public:
+     Add_median_ToUDAFMap()
+     {
+         UDAFMap::getMap()["median"] = new median();
+     }
+ };
+
+ static Add_median_ToUDAFMap addToMap;
+
+This defines an object whose constructor adds the entry to the UDAFMap. The 
+static declaration instatiates an object at runtime, thus adding the entry
+at startup. 
+
+