docs/Makefile

   1 thisdir = docs
   2 SUBDIRS =
   3 include ../build/rules.make
   4
   5 DISTFILES = \
   6         clr-abi.txt                 \
   7         compiler.txt                \
   8         control-flow-analysis.txt   \
   9         cs-errors.config            \
  10         monodoc.xml                 \
  11         new-anonymous-design.txt    \
  12         order.txt                   \
  13         $(DOC_SOURCE_FILES)         \
  14         $(wildcard ecma334/*.xml)
  15
  16 DOC_SOURCE_FILES = \
  17         lang-csharp.source          \
  18         Mono.source                 \
  19         netdocs.source              \
  20         Novell.source
  21
  22 ASSEMBLED_DOCS = \
  23         cs-errors.tree cs-errors.zip      \
  24         ecma334.tree ecma334.zip          \
  25         Mono.tree Mono.zip                \
  26         netdocs.tree netdocs.zip          \
  27         Novell.tree Novell.zip
  28
  29 MONODOC_SOURCES_INSTALL_FILES = \
  30         $(ASSEMBLED_DOCS)             \
  31         $(DOC_SOURCE_FILES)
  32
  33 CLEAN_FILES += $(ASSEMBLED_DOCS)
  34
  35 ifeq (net_2_0, $(PROFILE))
  36 all-local: build-documentation
  37 endif
  38
  39 all-local test-local run-test-local run-test-ondotnet-local doc-update:
  40
  41 clean-local:
  42         -rm -f $(CLEAN_FILES)
  43
  44 dist-local: dist-default
  45
  46
  47 MONODOC_INSTALL_DIR = $(DESTDIR)$(mono_libdir)/monodoc
  48
  49 ifdef DISABLE_MCS_DOCS
  50 install-local:
  51
  52 uninstall-local:
  53
  54 else
  55 install-local:
  56         $(MKINSTALLDIRS) $(MONODOC_INSTALL_DIR) $(MONODOC_INSTALL_DIR)/sources
  57         $(INSTALL_DATA) $(MONODOC_SOURCES_INSTALL_FILES) $(MONODOC_INSTALL_DIR)/sources
  58         $(INSTALL_DATA) monodoc.xml $(MONODOC_INSTALL_DIR)
  59
  60 uninstall-local:
  61         -rm -f $(MONODOC_INSTALL_DIR)/monodoc.xml
  62         -rm -f $(addprefix $(MONODOC_INSTALL_DIR)/sources/,$(MONODOC_SOURCES_INSTALL_FILES))
  63 endif
  64
  65
  66
  67 classdir = $(topdir)/class
  68 doc_en   = Documentation/en
  69
  70 NETDOCS_DIRS = \
  71         $(classdir)/corlib/$(doc_en)                                        \
  72         $(classdir)/Microsoft.Build.Engine/$(doc_en)                        \
  73         $(classdir)/Microsoft.Build.Framework/$(doc_en)                     \
  74         $(classdir)/Microsoft.Build.Utilities/$(doc_en)                     \
  75         $(classdir)/System.Configuration.Install/$(doc_en)                  \
  76         $(classdir)/System.Core/$(doc_en)                                   \
  77         $(classdir)/System.Data/$(doc_en)                                   \
  78         $(classdir)/System.Design/$(doc_en)                                 \
  79         $(classdir)/System.DirectoryServices/$(doc_en)                      \
  80         $(classdir)/System.Drawing/$(doc_en)                                \
  81         $(classdir)/System.Runtime.Remoting/$(doc_en)                       \
  82         $(classdir)/System.Runtime.Serialization.Formatters.Soap/$(doc_en)  \
  83         $(classdir)/System.Security/$(doc_en)                               \
  84         $(classdir)/System.Web.Services/$(doc_en)                           \
  85         $(classdir)/System.Web/$(doc_en)                                    \
  86         $(classdir)/System.XML/$(doc_en)                                    \
  87         $(classdir)/System/$(doc_en)                                        \
  88
  89 MONO_DIRS = \
  90         $(classdir)/Commons.Xml.Relaxng/$(doc_en)          \
  91         $(classdir)/Mono.Cairo/$(doc_en)                   \
  92         $(classdir)/Mono.Data.SqliteClient/$(doc_en)       \
  93         $(classdir)/Mono.GetOptions/$(doc_en)              \
  94         $(classdir)/Mono.Options/$(doc_en)                 \
  95         $(classdir)/Mono.Posix/$(doc_en)                   \
  96         $(classdir)/Mono.Security.Win32/$(doc_en)          \
  97         $(classdir)/Mono.Security/$(doc_en)                \
  98         $(classdir)/Mono.Simd/$(doc_en)                    \
  99         $(classdir)/Npgsql/$(doc_en)                       \
 100         $(topdir)/tools/csharplib/en
 101
 102 NOVELL_DIRS = \
 103         $(topdir)/class/Novell.Directory.Ldap/Documentation/en
 104
 105 NUNIT_DIRS = \
 106         $(topdir)/nunit20/core/$(doc_en)       \
 107         $(topdir)/nunit20/framework/$(doc_en)  \
 108         $(topdir)/nunit20/mocks/$(doc_en)      \
 109         $(topdir)/nunit20/util/$(doc_en)
 110
 111 ifdef DISABLE_MCS_DOCS
 112 build-documentation:
 113 else
 114 build-documentation: $(ASSEMBLED_DOCS)
 115 endif
 116
 117 # To support `make -jN`, we can't mention multiple targets in the same rule;
 118 # DO NOT DO THIS:
 119 #
 120 #         foo.tree foo.zip : Makefile
 121 #     $(MDOC) assemble -o foo $(FOO_DIRS)
 122 #
 123 # If you do, make will try to biuld foo.tree & foo.zip concurrently, which
 124 # breaks things badly... (read: "mdoc: sharing violation on path...foo.zip").
 125 #
 126 # The proper solution is to chain the rule dependencies so that only one file
 127 # is the target of a rule.
 128
 129 netdocs.zip : netdocs.tree
 130 netdocs.tree: Makefile
 131         $(MDOC) assemble -o netdocs $(NETDOCS_DIRS)
 132
 133 Mono.zip : Mono.tree
 134 Mono.tree: Makefile
 135         $(MDOC) assemble -o Mono $(MONO_DIRS)
 136
 137 Novell.zip : Novell.tree
 138 Novell.tree: Makefile
 139         $(MDOC) assemble -o Novell $(NOVELL_DIRS)
 140
 141 cs-errors.zip : cs-errors.tree
 142 cs-errors.tree: cs-errors.config Makefile
 143         $(MDOC) assemble -o cs-errors -f error $<
 144
 145 ecma334.zip : ecma334.tree
 146 ecma334.tree: Makefile
 147         $(MDOC) assemble -o ecma334 -f ecmaspec ecma334
 148