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