make/UpdateBuildDocs.gmk
author tschatzl
Mon, 30 Sep 2019 10:21:11 +0200
changeset 58394 b1c3d24553e0
parent 55166 2ae056696b15
child 58909 66f7d2494d4e
permissions -rw-r--r--
8231553: Deprecate unused G1RSetScanBlockSize command line option Reviewed-by: lkorinth, sjohanss
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     1
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     2
# Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     3
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     4
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     5
# This code is free software; you can redistribute it and/or modify it
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     6
# under the terms of the GNU General Public License version 2 only, as
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     7
# published by the Free Software Foundation.  Oracle designates this
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     8
# particular file as subject to the "Classpath" exception as provided
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
     9
# by Oracle in the LICENSE file that accompanied this code.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    10
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    11
# This code is distributed in the hope that it will be useful, but WITHOUT
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    13
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    14
# version 2 for more details (a copy is included in the LICENSE file that
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    15
# accompanied this code).
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    16
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    17
# You should have received a copy of the GNU General Public License version
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    18
# 2 along with this work; if not, write to the Free Software Foundation,
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    19
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    20
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    21
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    22
# or visit www.oracle.com if you need additional information or have any
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    23
# questions.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    24
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    25
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    26
default: all
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    27
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    28
include $(SPEC)
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    29
include MakeBase.gmk
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    30
include ProcessMarkdown.gmk
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    31
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    32
################################################################################
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    33
# This makefile updates the generated build html documentation.
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    34
#
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    35
################################################################################
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    36
53442
b156fd0a4607 8217448: Check for pandoc availability using ENABLE_PANDOC and not PANDOC
ihse
parents: 47314
diff changeset
    37
ifeq ($(ENABLE_PANDOC), false)
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    38
  $(info No pandoc executable was detected by configure)
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    39
  $(error Cannot continue)
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    40
endif
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    41
47217
72e3ae9a25eb 8187444: Forest Consolidation: Make build work
erikj
parents: 45763
diff changeset
    42
GLOBAL_SPECS_DEFAULT_CSS_FILE := $(TOPDIR)/make/data/docs-resources/resources/jdk-default.css
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    43
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    44
################################################################################
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    45
47217
72e3ae9a25eb 8187444: Forest Consolidation: Make build work
erikj
parents: 45763
diff changeset
    46
DOCS_DIR := $(TOPDIR)/doc
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    47
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    48
$(eval $(call SetupProcessMarkdown, building, \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    49
  FILES := $(DOCS_DIR)/building.md, \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    50
  DEST := $(DOCS_DIR), \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    51
  CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
45763
2a2e56f4c03b 8179892: Update build documentation for JDK 9
ihse
parents: 44983
diff changeset
    52
  OPTIONS := --toc, \
44511
f3c27401a860 8177955: Add testing documentation
ihse
parents: 44078
diff changeset
    53
))
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    54
TARGETS += $(building)
44511
f3c27401a860 8177955: Add testing documentation
ihse
parents: 44078
diff changeset
    55
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    56
$(eval $(call SetupProcessMarkdown, testing, \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    57
  FILES := $(DOCS_DIR)/testing.md, \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    58
  DEST := $(DOCS_DIR), \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    59
  CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
44511
f3c27401a860 8177955: Add testing documentation
ihse
parents: 44078
diff changeset
    60
  OPTIONS := --toc, \
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    61
))
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44511
diff changeset
    62
TARGETS += $(testing)
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    63
55166
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    64
$(eval $(call SetupProcessMarkdown, ide, \
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    65
  FILES := $(DOCS_DIR)/ide.md, \
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    66
  DEST := $(DOCS_DIR), \
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    67
  CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    68
  OPTIONS := --toc, \
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    69
))
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    70
TARGETS += $(ide)
2ae056696b15 8223678: Add Visual Studio Code workspace generation support (for native code)
rwestberg
parents: 53442
diff changeset
    71
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    72
################################################################################
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    73
47314
743814386712 8188814: Simplify IncludeCustomExtension
ihse
parents: 47217
diff changeset
    74
$(eval $(call IncludeCustomExtension, UpdateBuildDocs.gmk))
44078
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    75
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    76
################################################################################
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    77
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    78
all: $(TARGETS)
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    79
673240c54c2e 8176509: Use pandoc for converting build readme to html
ihse
parents:
diff changeset
    80
.PHONY: all default