Page MenuHomeClusterLabs Projects
Files F3686961

No OneTemporary
Actions

View Options

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f90d288c54..448d03b867 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,172 +1,172 @@
#
# Copyright 2003-2023 the Pacemaker project contributors
#
# The version control history for this file may have further details.
#
# This source code is licensed under the GNU General Public License version 2
# or later (GPLv2+) WITHOUT ANY WARRANTY.
#
include $(top_srcdir)/mk/common.mk
# Define release-related variables
include $(top_srcdir)/mk/release.mk
# What formats to use for book uploads (i.e. "make www";
# use BOOK_FORMATS in sphinx subdirectory to change local builds)
BOOK_FORMATS ?= html \
singlehtml \
pdf \
epub
# SNMP MIB
mibdir = $(datadir)/snmp/mibs
dist_mib_DATA = PCMK-MIB.txt
# Deprecated plaintext documents (dynamically converted to HTML)
DEPRECATED_ORIGINAL = crm_fencing.txt
DEPRECATED_GENERATED =
if BUILD_ASCIIDOC
DEPRECATED_GENERATED += $(DEPRECATED_ORIGINAL:%.txt=%.html)
endif
DEPRECATED_ALL = $(DEPRECATED_ORIGINAL) \
$(DEPRECATED_GENERATED)
doc_DATA = $(DEPRECATED_ALL)
noinst_SCRIPTS = abi-check
SUBDIRS = sphinx
EXTRA_DIST = $(DEPRECATED_ORIGINAL)
# toplevel rsync destination for www targets (without trailing slash)
-RSYNC_DEST ?= root@www.clusterlabs.org:/var/www/html
+RSYNC_DEST ?= sites.clusterlabs.org:/var/www/html
# recursive, preserve symlinks, preserve permissions, verbose, compress,
# don't cross filesystems, sparse, show progress
RSYNC_OPTS = -rlpvzxS --progress
if IS_ASCIIDOC
ASCIIDOC_HTML_ARGS = --unsafe --backend=xhtml11
ASCIIDOC_DBOOK_ARGS = -b docbook -d book
else
ASCIIDOC_HTML_ARGS = --backend=html5
ASCIIDOC_DBOOK_ARGS = -b docbook45 -d book
endif
%.html: %.txt
$(AM_V_GEN)$(ASCIIDOC_CONV) $(ASCIIDOC_HTML_ARGS) --out-file=$@ $< $(PCMK_quiet)
# For Makefile debugging
.PHONY: vars
vars:
@echo DEPRECATED_ORIGINAL=\'$(DEPRECATED_ORIGINAL)\'
@echo DEPRECATED_GENERATED=\'$(DEPRECATED_GENERATED)\'
@echo LAST_RELEASE=\'$(LAST_RELEASE)\'
@echo TAG=\'$(TAG)\'
.PHONY: deprecated-upload
deprecated-upload: $(DEPRECATED_ALL)
rsync $(RSYNC_OPTS) $(DEPRECATED_ALL) "$(RSYNC_DEST)/$(PACKAGE)/doc/"
.PHONY: deprecated-clean
deprecated-clean:
-rm -f $(DEPRECATED_GENERATED)
# Annotated source code as HTML
# Cleaning first ensures we don't index unrelated stuff like RPM sources
.PHONY: global
global:
$(MAKE) $(AM_MAKEFLAGS) -C .. clean-generic
$(MAKE) $(AM_MAKEFLAGS) -C ../rpm rpm-clean
cd .. && gtags -q && htags -sanhIT doc
.PHONY: global-upload
global-upload: global
rsync $(RSYNC_OPTS) HTML/ "$(RSYNC_DEST)/$(PACKAGE)/global/$(TAG)/"
.PHONY: global-clean
global-clean:
-rm -rf HTML
# Man pages as HTML
%.8.html: %.8
groff -mandoc `man -w ./$<` -T html > $@
%.7.html: %.7
groff -mandoc `man -w ./$<` -T html > $@
.PHONY: manhtml
manhtml:
$(MAKE) $(AM_MAKEFLAGS) -C .. all
find ../agents ../daemons ../tools -name "[a-z]*.[78]" \
-exec $(MAKE) $(AM_MAKEFLAGS) \{\}.html \;
.PHONY: manhtml-upload
manhtml-upload: manhtml
find .. -name "[a-z]*.[78].html" -exec \
rsync $(RSYNC_OPTS) \{\} "$(RSYNC_DEST)/$(PACKAGE)/man/" \;
.PHONY: manhtml-clean
manhtml-clean:
-find .. -name "[a-z]*.[78].html" -exec rm \{\} \;
# API documentation as HTML
.PHONY: doxygen
doxygen: Doxyfile
doxygen Doxyfile
.PHONY: doxygen-upload
doxygen-upload: doxygen
rsync $(RSYNC_OPTS) api/html/ "$(RSYNC_DEST)/$(PACKAGE)/doxygen/$(TAG)/"
.PHONY: doxygen-clean
doxygen-clean:
-rm -rf api
# ABI compatibility report as HTML
.PHONY: abi
abi: abi-check
./abi-check $(PACKAGE) $(LAST_RELEASE) $(TAG)
.PHONY: abi-www
abi-www:
export RSYNC_DEST=$(RSYNC_DEST); ./abi-check -u $(PACKAGE) $(LAST_RELEASE) $(TAG)
.PHONY: abi-clean
abi-clean:
-rm -rf abi_dumps compat_reports
# The main documentation books (which are actually in the sphinx subdirectory)
.PHONY: books-upload
books-upload:
$(MAKE) $(AM_MAKEFLAGS) -C sphinx clean
$(MAKE) $(AM_MAKEFLAGS) -C sphinx \
RSYNC_DEST="$(RSYNC_DEST)" \
BOOK_FORMATS="$(BOOK_FORMATS)" \
books-upload
# All online documentation (except ABI compatibility, which is run separately)
.PHONY: www
www: clean-local deprecated-upload manhtml-upload global-upload doxygen-upload books-upload
.PHONY: clean-local
clean-local: global-clean manhtml-clean doxygen-clean abi-clean deprecated-clean
# "make check" will cause "make all" to be run, which means docs will get built
# as a part of running tests if they haven't already. That seems unnecessary, so
# override the default check-recursive rule with this one that just returns. If
# we ever need to add tests to this directory, this rule will have to come out.
.PHONY: check-recursive
check-recursive:
@true

File Metadata

Mime Type
text/x-diff
Expires
Mon, Apr 21, 6:15 PM (1 d, 4 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1653492
Default Alt Text
(4 KB)

Event Timeline