tools/mdoc/Makefile

   1 thisdir = tools/mdoc
   2 SUBDIRS =
   3 include ../../build/rules.make
   4
   5 MDOC_COMMON_FLAGS = \
   6         /resource:../monodoc/Resources/mdoc-html-format.xsl,mdoc-html-format.xsl    \
   7         /resource:../monodoc/Resources/mdoc-html-utils.xsl,mdoc-html-utils.xsl      \
   8         /resource:../monodoc/Resources/mdoc-sections-css.xsl,mdoc-sections-css.xsl  \
   9         /resource:../monodoc/Resources/mono-ecma-css.xsl,mono-ecma-css.xsl          \
  10         /resource:Resources/defaulttemplate.xsl,defaulttemplate.xsl                 \
  11         /resource:Resources/monodoc-ecma.xsd,monodoc-ecma.xsd                       \
  12         /resource:Resources/overview.xsl,overview.xsl                               \
  13         /resource:Resources/stylesheet.xsl,stylesheet.xsl                           \
  14         /r:System.Web.dll                                                           \
  15         /r:System.Xml.Linq.dll                                                      \
  16         /r:ICSharpCode.SharpZipLib.dll                                              \
  17         /r:$(topdir)/class/lib/net_4_0/Mono.Cecil.dll
  18
  19 LOCAL_MCS_FLAGS = $(MDOC_COMMON_FLAGS) \
  20         /r:$(topdir)/class/lib/net_2_0/monodoc.dll
  21 PROGRAM = mdoc.exe
  22 PROGRAM_DEPS = $(topdir)/class/lib/net_2_0/monodoc.dll
  23
  24 ifdef NET
  25 all : copy-with-deps
  26
  27 copy-with-deps:
  28         -mkdir mdoc-net
  29         cp $(PROGRAM) mdoc-net
  30         cp $(topdir)/class/lib/net_4_0/Commons.Xml.Relaxng.dll mdoc-net
  31         cp $(topdir)/class/lib/net_4_0/ICSharpCode.SharpZipLib.dll mdoc-net
  32         cp $(topdir)/class/lib/net_4_0/Mono.Cecil.dll mdoc-net
  33         cp $(topdir)/class/lib/net_2_0/monodoc.dll mdoc-net
  34 endif
  35
  36 MONODOC_RESOURCES = \
  37         ../monodoc/Resources/mdoc-html-utils.xsl    \
  38         ../monodoc/Resources/mdoc-sections-css.xsl  \
  39         ../monodoc/Resources/mono-ecma-css.xsl
  40
  41 MDOC_RESOURCES = \
  42         Resources/defaulttemplate.xsl     \
  43         Resources/monodoc-ecma.xsd        \
  44         Resources/overview.xsl            \
  45         Resources/stylesheet.xsl
  46
  47 MDOC_TEST_FILES = \
  48         Test/DocTest-v1.cs                                        \
  49         Test/DocTest-v2.patch                                     \
  50         Test/msxdoc-expected.importslashdoc.xml                   \
  51         Test/TestEcmaDocs.xml                                     \
  52         Test/validate.check.monodocer                             \
  53         Test/validate.check.monodocer.importslashdoc              \
  54         Test/validate.check.monodocer.since
  55
  56 EXTRA_DISTFILES = \
  57         $(MDOC_RESOURCES) \
  58         $(MDOC_TEST_FILES)
  59
  60 $(PROGRAM) : $(MDOC_RESOURCES) $(MONODOC_RESOURCES) $(PROGRAM_DEPS)
  61
  62 include ../../build/executable.make
  63
  64 $(PROGRAM) : Makefile
  65
  66 MONO = \
  67         MONO_PATH="$(topdir)/class/lib/2.0$(PLATFORM_PATH_SEPARATOR)$$MONO_PATH" \
  68         $(RUNTIME) $(RUNTIME_FLAGS)
  69
  70 dist-local: dist-default dist-tests
  71
  72 dist-tests:
  73         find Test/en.expected* -name '*.xml'     > .files
  74         find Test/html.expected* -name '*.html' >> .files
  75         tar cTf .files - | (cd $(distdir); tar xf -)
  76         rm .files ; \
  77
  78 test-local: $(PROGRAM)
  79
  80 clean-local: cleanup
  81
  82 cleanup:
  83         -rm -Rf Test/en.actual Test/html.actual
  84         -rm -f monodocer1.exe*
  85
  86 Test/DocTest.dll:
  87         $(CSCOMPILE) $(TEST_CSCFLAGS) -debug -unsafe -target:library -out:$@ Test/DocTest.cs
  88
  89 Test/DocTest.dll-v1:
  90         -rm -f Test/DocTest.cs
  91         cp Test/DocTest-v1.cs Test/DocTest.cs
  92         -rm -f Test/DocTest.dll
  93         $(MAKE) TEST_CSCFLAGS=$(TEST_CSCFLAGS) Test/DocTest.dll
  94
  95 Test/DocTest.dll-v2:
  96         -rm -f Test/DocTest.cs
  97         cp Test/DocTest-v1.cs Test/DocTest.cs
  98         cd Test && patch -p0 < DocTest-v2.patch
  99         -rm -f Test/DocTest.dll
 100         $(MAKE) TEST_CSCFLAGS=$(TEST_CSCFLAGS) Test/DocTest.dll
 101
 102 check-monodocer-update: $(PROGRAM)
 103         find Test/en.expected -name \*.xml -exec rm "{}" \;
 104         $(MAKE) Test/DocTest.dll-v1
 105         $(MONO) $(PROGRAM) update --exceptions=all -o Test/en.expected Test/DocTest.dll
 106
 107 check-monodocer: $(PROGRAM)
 108         -rm -Rf Test/en.actual
 109         $(MAKE) Test/DocTest.dll-v1
 110         $(MONO) $(PROGRAM) update --exceptions=all -o Test/en.actual Test/DocTest.dll
 111         diff --exclude=.svn -rup Test/en.expected Test/en.actual
 112         $(MONO) $(PROGRAM) update --exceptions=all -o Test/en.actual Test/DocTest.dll
 113         diff --exclude=.svn -rup Test/en.expected Test/en.actual
 114
 115 check-monodocer-since-update: $(PROGRAM)
 116         find Test/en.expected.since -name \*.xml -exec rm "{}" \;
 117         $(MAKE) Test/DocTest.dll-v1
 118         $(MONO) $(PROGRAM) update --exceptions=all -o Test/en.expected.since Test/DocTest.dll
 119         $(MAKE) Test/DocTest.dll-v2
 120         $(MONO) $(PROGRAM) update --exceptions=all --since="Version 2.0" \
 121                 -o Test/en.expected.since Test/DocTest.dll
 122
 123 check-monodocer-since: $(PROGRAM)
 124         rm -Rf Test/en.actual
 125         $(MAKE) Test/DocTest.dll-v1
 126         $(MONO) $(PROGRAM) update --exceptions=all -o Test/en.actual Test/DocTest.dll
 127         $(MAKE) Test/DocTest.dll-v2
 128         $(MONO) $(PROGRAM) update --exceptions=all --since="Version 2.0" \
 129                 -o Test/en.actual Test/DocTest.dll
 130         diff --exclude=.svn -rup Test/en.expected.since Test/en.actual
 131
 132 check-monodocer-importslashdoc-update: $(PROGRAM)
 133         find Test/en.expected.importslashdoc -name \*.xml -exec rm "{}" \;
 134         $(MAKE) Test/DocTest.dll-v1 TEST_CSCFLAGS=-doc:Test/DocTest.xml
 135         $(MONO) $(PROGRAM) update --exceptions=all -i Test/DocTest.xml \
 136                 -o Test/en.expected.importslashdoc Test/DocTest.dll
 137
 138 check-monodocer-importslashdoc: $(PROGRAM)
 139         rm -Rf Test/en.actual
 140         $(MAKE) Test/DocTest.dll-v1 TEST_CSCFLAGS=-doc:Test/DocTest.xml
 141         $(MONO) $(PROGRAM) update --exceptions=all -i Test/DocTest.xml \
 142                 -o Test/en.actual Test/DocTest.dll
 143         diff --exclude=.svn -rup Test/en.expected.importslashdoc Test/en.actual
 144
 145 check-monodocer-importecmadoc-update: $(PROGRAM)
 146         find Test/en.expected.importecmadoc -name \*.xml -exec rm "{}" \;
 147         $(MAKE) Test/DocTest.dll-v1
 148         $(MONO) $(PROGRAM) update --exceptions=all -i Test/TestEcmaDocs.xml \
 149                 '--type=System.Action`1' --type=System.AsyncCallback \
 150                 --type=System.Environment --type=System.Array \
 151                 -o Test/en.expected.importecmadoc Test/DocTest.dll
 152
 153 check-monodocer-importecmadoc: $(PROGRAM)
 154         rm -Rf Test/en.actual
 155         $(MAKE) Test/DocTest.dll-v1
 156         $(MONO) $(PROGRAM) update --exceptions=all -i Test/TestEcmaDocs.xml \
 157                 '--type=System.Action`1' --type=System.AsyncCallback \
 158                 --type=System.Environment --type=System.Array \
 159                 -o Test/en.actual Test/DocTest.dll
 160         diff --exclude=.svn -rup Test/en.expected.importecmadoc Test/en.actual
 161
 162 check-mdoc-export-html-update: $(PROGRAM)
 163         find Test/html.expected -name \*.html -exec rm "{}" \;
 164         $(MONO) $(PROGRAM) export-html -o Test/html.expected \
 165                 Test/en.expected.importslashdoc
 166
 167 check-mdoc-export-html: check-monodocer $(PROGRAM)
 168         rm -Rf Test/html.actual
 169         $(MONO) $(PROGRAM) export-html -o Test/html.actual \
 170                 Test/en.expected.importslashdoc
 171         diff --exclude=.svn -rup Test/html.expected Test/html.actual
 172
 173 check-mdoc-export-html-with-version: $(PROGRAM)
 174         rm -Rf Test/html.actual.v0 Test/html.actual.since-with-v0 .v0.txt .v2.txt
 175         $(MONO) $(PROGRAM) export-html -o Test/html.actual.v0 \
 176                 Test/en.expected
 177         $(MONO) $(PROGRAM) export-html -o Test/html.actual.since-with-v0 \
 178                 Test/en.expected.since -with-version 0.0.0.0
 179         (cd Test/html.actual.v0            && find . -type f) | sort > .v0.txt
 180         (cd Test/html.actual.since-with-v0 && find . -type f) | sort > .v2.txt
 181         diff -rup .v0.txt .v2.txt   # assert no types added
 182
 183 check-md-html-dir: $(PROGRAM)
 184         rm -Rf Test/html.actual
 185         $(MONO) $(PROGRAM) export-html -dest:Test/html.actual $(DIR)
 186         diff --exclude=.svn -rup Test/html.expected Test/html.actual
 187
 188 check-mdoc-export-msxdoc-update:
 189         $(MONO) $(PROGRAM) export-msxdoc -o - Test/en.expected.importslashdoc \
 190                 > Test/msxdoc-expected.importslashdoc.xml
 191
 192 check-mdoc-export-msxdoc:
 193         $(MONO) $(PROGRAM) export-msxdoc -o - Test/en.expected.importslashdoc \
 194                 | diff --brief - Test/msxdoc-expected.importslashdoc.xml
 195
 196 my_abs_top_srcdir = $(shell cd . && pwd)
 197
 198 check-mdoc-validate-update: $(PROGRAM)
 199         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected 2>&1 | \
 200                 sed 's#file://$(my_abs_top_srcdir)/##g' > \
 201                 Test/validate.check.monodocer
 202         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected.importslashdoc 2>&1 | \
 203                 sed 's#file://$(my_abs_top_srcdir)/##g' > \
 204                 Test/validate.check.monodocer.importslashdoc
 205         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected.since 2>&1 | \
 206                 sed 's#file://$(my_abs_top_srcdir)/##g' > \
 207                 Test/validate.check.monodocer.since
 208
 209 check-mdoc-validate: $(PROGRAM)
 210         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected 2>&1 | \
 211                 sed 's#file://$(my_abs_top_srcdir)/##g' | \
 212                 diff - Test/validate.check.monodocer
 213         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected.importslashdoc 2>&1 | \
 214                 sed 's#file://$(my_abs_top_srcdir)/##g' | \
 215                 diff --brief - Test/validate.check.monodocer.importslashdoc
 216         $(MONO) $(PROGRAM) validate -f ecma Test/en.expected.since 2>&1 | \
 217                 sed 's#file://$(my_abs_top_srcdir)/##g' | \
 218                 diff --brief - Test/validate.check.monodocer.since
 219
 220 run-test-local: check-doc-tools
 221
 222 run-test-update : check-doc-tools-update
 223
 224 check-doc-tools: check-monodocer-since \
 225         check-monodocer-importecmadoc \
 226         check-monodocer-importslashdoc \
 227         check-monodocer \
 228         check-mdoc-export-html \
 229         check-mdoc-export-html-with-version \
 230         check-mdoc-export-msxdoc \
 231         check-mdoc-validate
 232
 233 check-doc-tools-update: check-monodocer-since-update \
 234         check-monodocer-importecmadoc-update \
 235         check-monodocer-importslashdoc-update \
 236         check-monodocer-update \
 237         check-mdoc-export-html-update \
 238         check-mdoc-export-msxdoc-update \
 239         check-mdoc-validate-update
 240