X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2FMakefile.am;h=0da96cde6edc20fcfabd25dca913261435bd8324;hb=1121816c4a4e1bb2ef097c4a9802362181c43800;hp=dce13432fd71a88736db80808681f793ec64207d;hpb=f3534ab9f5cc35eafb32cb629c617098e67ef7f4;p=fs%2Flustre-release.git diff --git a/lustre/doc/Makefile.am b/lustre/doc/Makefile.am index dce1343..0da96cd 100644 --- a/lustre/doc/Makefile.am +++ b/lustre/doc/Makefile.am @@ -1,124 +1,242 @@ -# Copyright (C) 2001, 2002 Cluster File Systems, Inc. # -# This code is issued under the GNU General Public License. -# See the file COPYING in this distribution -LYX2PDF = GS_OPTIONS=-dCompatibilityLevel=1.1 $(srcdir)/tex2pdf -overwrite -TEX2PDF = GS_OPTIONS=-dCompatibilityLevel=1.1 $(srcdir)/tex2pdf -overwrite -LYX2PS = lyx --export ps -LYX2TEX = lyx --export latex -LYX2TXT = lyx --export text -LYX2HTML = lyx --export html -LATEX = latex -DVIPS = dvips -PS2PDF = ps2pdf -TEXEXPAND = texexpand -SUFFIXES = .lin .lyx .pdf .ps .sgml .html .txt .tex .fig .eps .dvi - -if DOC - DOCS = lustre.pdf recovery-manual.pdf -else - DOCS = -endif - -IMAGES := $(patsubst %.fig,%.eps,$(wildcard *.fig)) -LYXFILES= $(filter-out $(patsubst %.lin,%.lyx,$(wildcard *.lin)),\ - $(wildcard *.lin *.lyx)) - -MAINTAINERCLEANFILES = $(IMAGES) $(DOCS) $(VERSIONED) -CLEANFILES = *.aux *.tex doc.old/*.aux doc.old/*.tex *.eps *.log *.pdf -VERSIONED = lustre.lyx doc.old/lustre.lyx -GENERATED = $(VERSIONED) lustre-full.tex lustre-chbar.tex - -EXTRA_DIST = chbar.sh postbar tex2pdf $(DOCS) $(IMAGES) $(LYXFILES) lustre.bib - -all: -docs: $(DOCS) - -# These variables are set by lbuild/check-build. -RPMRELEASE ?= RELEASE -KERNTYPE ?= chaos -KERNRPM ?= kernel-2.4.18lustre13-RELEASE.i386.rpm - -# update date and version in document -date := $(shell date +%x) -tag := $(shell echo '$$Name: $$' | sed -e 's/^\$$Na''me: *\$$$$/HEAD/; s/^\$$Na''me: \(.*\) \$$$$/\1/') -addversion = sed -e 's|@T''AG@|$(tag)|g; s|@VER''SION@|$(VERSION)|g; s|@DA''TE@|$(date)|g; s|@RPM''RELEASE@|$(RPMRELEASE)|g; s|@KERN''TYPE@|$(KERNTYPE)|g; s|@KERN''RPM@|$(KERNRPM)|g' - -# Regenerate when the $(VERSION) or $Name: $ changes. -.INTERMEDIATE: $(GENERATED) -$(VERSIONED) : %.lyx: %.lin Makefile - $(addversion) $< > $@ - -.lyx.pdf: - @echo $(LYX2PDF) $< && $(LYX2PDF) $< || printf "\n*** Warning: not creating PDF docs; install lyx to rectify this\n" - -.lyx.ps: - @echo $(LYX2PS) $< && $(LYX2PS) $< || printf "\n*** Warning: not creating PostScript docs; install lyx to rectify this\n" - -.lyx.tex: - @echo $(LYX2TEX) $< && $(LYX2TEX) $< || printf "\n*** Warning: not creating LaTeX docs; install lyx to rectify this\n" - -.lyx.txt: - @echo $(LYX2TXT) $< && $(LYX2TXT) $< || printf "\n*** Warning: not creating text docs; install lyx to rectify this\n" - -.lyx.html: - @echo $(LYX2HTML) $< && $(LYX2HTML) $< || printf "\n*** Warning: not creating HTML docs; install lyx to rectify this\n" - -.tex.pdf: - $(TEX2PDF) $< - -.tex.dvi: - $(LATEX) $< - $(LATEX) $< - -.dvi.ps: - $(DVIPS) $< -o $@ - -.ps.pdf: - $(PS2PDF) $< $@ - -lustre.tex recovery-manual.tex lustre.pdf recovery-manual.pdf lustre.txt lustre.html: $(IMAGES) $(LYXFILES) -.fig.eps: - -fig2dev -L eps $< > $@ - -syncweb: lustre.pdf - cp lustre.pdf /usr/src/www/content/lustre/docs/lustre.pdf - ( cd /usr/src/www ; make lustre ; make synclustre ) -.PHONY: syncweb chbar +# GPL HEADER START +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 only, +# as published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License version 2 for more details (a copy is included +# in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU General Public License +# version 2 along with this program; If not, see +# http://www.gnu.org/licenses/gpl-2.0.html +# +# GPL HEADER END +# -# Build a changebar document from the files in doc.old and this directory. -chbar: lustre-chbar.pdf +# +# Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved. +# Use is subject to license terms. +# +# Copyright (c) 2011, 2017, Intel Corporation. +# -# FIXME: Temporary rules until pdftex displays changebars correctly. -lustre-chbar.pdf: lustre-chbar-nopdf.ps - $(PS2PDF) $< $@ -lustre-chbar-nopdf.ps: lustre-chbar-nopdf.dvi - $(DVIPS) $< -o $@ -lustre-chbar-nopdf.dvi: lustre-chbar-nopdf.tex - $(LATEX) $< - $(LATEX) $< -lustre-chbar-nopdf.tex: lustre-chbar.tex - sed -e 's/^\(.*usepackage.*pdftex\)/%\1/' $< > $@ +# +# This file is part of Lustre, http://www.lustre.org/ +# -%-chbar.tex: chbar.sh postbar doc.old/%-full.tex %-full.tex - $(SHELL) $(srcdir)/chbar.sh doc.old/$*-full.tex $*-full.tex | $(srcdir)/postbar > $@ +MANFILES = \ + lctl.8 \ + lctl-get_param.8 \ + lctl-list_param.8 \ + lctl-network.8 \ + lctl-pcc.8 \ + lctl-pool_add.8 \ + lctl-pool_new.8 \ + lctl-set_param.8 \ + ldev.8 \ + ldev.conf.5 \ + lfs.1 \ + lfs-df.1 \ + lfs-fid2path.1 \ + lfs-find.1 \ + lfs-flushctx.1 \ + lfs-getdirstripe.1 \ + lfs-getname.1 \ + lfs-getsom.1 \ + lfs-getstripe.1 \ + lfs-heat.1 \ + lfs-hsm.1 \ + lfs-hsm_action.1 \ + lfs-hsm_clear.1 \ + lfs-hsm_set.1 \ + lfs-hsm_state.1 \ + lfs-ladvise.1 \ + lfs_migrate.1 \ + lfs-migrate.1 \ + lfs-mirror-copy.1 \ + lfs-mirror-create.1 \ + lfs-mirror-delete.1 \ + lfs-mirror-extend.1 \ + lfs-mirror-read.1 \ + lfs-mirror-resync.1 \ + lfs-mirror-split.1 \ + lfs-mirror-verify.1 \ + lfs-mirror-write.1 \ + lfs-mkdir.1 \ + lfs-path2fid.1 \ + lfs-pcc-detach.1 \ + lfs-pcc.1 \ + lfs-project.1 \ + lfs-quota.1 \ + lfs-rmfid.1 \ + lfs-setdirstripe.1 \ + lfs-setquota.1 \ + lfs-setstripe.1 \ + lgss_sk.8 \ + lhbadm.8 \ + ll_decode_linkea.8 \ + llsom_sync.8 \ + llstat.8 \ + lnetctl.8 \ + lst.8 \ + lustre.7 \ + lustre_routes_config.8 \ + lustre_routes_conversion.8 \ + lustre_rsync.8 \ + mount.lustre.8 \ + nids.5 \ + plot-llstat.8 \ + routerstat.8 + + +LIBMAN = \ + lustreapi.7 \ + llapi_create_volatile_param.3 \ + llapi_fd2parent.3 \ + llapi_fid_parse.3 \ + llapi_file_create.3 \ + llapi_file_create_foreign.3 \ + llapi_file_get_stripe.3 \ + llapi_file_open.3 \ + llapi_get_fsname.3 \ + llapi_get_fsname_instance.3 \ + llapi_get_instance.3 \ + llapi_get_lum_dir.3 \ + llapi_get_lum_dir_fd.3 \ + llapi_get_lum_file.3 \ + llapi_get_lum_file_fd.3 \ + llapi_getname.3 \ + llapi_group_lock.3 \ + llapi_group_unlock.3 \ + llapi_heat_get.3 \ + llapi_heat_set.3 \ + llapi_hsm_action_begin.3 \ + llapi_hsm_action_end.3 \ + llapi_hsm_action_get_dfid.3 \ + llapi_hsm_action_get_fd.3 \ + llapi_hsm_action_progress.3 \ + llapi_hsm_copytool_get_fd.3 \ + llapi_hsm_copytool_recv.3 \ + llapi_hsm_copytool_register.3 \ + llapi_hsm_copytool_unregister.3 \ + llapi_hsm_state_get.3 \ + llapi_hsm_state_set.3 \ + llapi_ladvise.3 \ + llapi_layout.7 \ + llapi_layout_alloc.3 \ + llapi_layout_comp_add.3 \ + llapi_layout_comp_del.3 \ + llapi_layout_comp_extent_get.3 \ + llapi_layout_comp_extent_set.3 \ + llapi_layout_comp_flags_clear.3 \ + llapi_layout_comp_flags_get.3 \ + llapi_layout_comp_flags_set.3 \ + llapi_layout_comp_id_get.3 \ + llapi_layout_comp_use.3 \ + llapi_layout_comp_use_id.3 \ + llapi_layout_extension_size_get.3 \ + llapi_layout_extension_size_set.3 \ + llapi_layout_file_comp_add.3 \ + llapi_layout_file_comp_del.3 \ + llapi_layout_file_create.3 \ + llapi_layout_file_open.3 \ + llapi_layout_free.3 \ + llapi_layout_get_by_fd.3 \ + llapi_layout_get_by_fid.3 \ + llapi_layout_get_by_path.3 \ + llapi_layout_get_by_xattr.3 \ + llapi_layout_ost_index_get.3 \ + llapi_layout_ost_index_set.3 \ + llapi_layout_pattern_get.3 \ + llapi_layout_pattern_set.3 \ + llapi_layout_pool_name_get.3 \ + llapi_layout_pool_name_set.3 \ + llapi_layout_stripe_count_get.3 \ + llapi_layout_stripe_count_set.3 \ + llapi_layout_stripe_size_get.3 \ + llapi_layout_stripe_size_set.3 \ + llapi_param_get_paths.3 \ + llapi_param_get_value.3 \ + llapi_path2fid.3 \ + llapi_path2parent.3 \ + llapi_pcc_attach.3 \ + llapi_pcc_attach_fid.3 \ + llapi_pcc_attach_fid_str.3 \ + llapi_pcc_detach_fid.3 \ + llapi_pcc_detach_fid_fd.3 \ + llapi_pcc_detach_fid_str.3 \ + llapi_pcc_detach_file.3 \ + llapi_pccdev_get.3 \ + llapi_pccdev_set.3 \ + llapi_pcc_state_get.3 \ + llapi_pcc_state_get_fd.3 \ + llapi_quotactl.3 \ + llapi_rmfid.3 \ + llapi_search_mdt.3 \ + llapi_search_ost.3 \ + llapi_search_tgt.3 \ + llapi_unlink_foreign.3 + +SERVER_MANFILES = \ + l_getidentity.8 \ + l_getsepol.8 \ + lctl-barrier.8 \ + lctl-changelog_deregister.8 \ + lctl-changelog_register.8 \ + lctl-lcfg.8 \ + lctl-lfsck-query.8 \ + lctl-lfsck-start.8 \ + lctl-lfsck-stop.8 \ + lctl-llog_cancel.8 \ + lctl-llog_catlist.8 \ + lctl-llog_info.8 \ + lctl-llog_print.8 \ + lctl-del_ost.8 \ + lctl-nodemap-activate.8 \ + lctl-nodemap-add-idmap.8 \ + lctl-nodemap-add-range.8 \ + lctl-nodemap-add.8 \ + lctl-nodemap-del-idmap.8 \ + lctl-nodemap-del-range.8 \ + lctl-nodemap-del.8 \ + lctl-nodemap-modify.8 \ + lctl-nodemap-set-fileset.8 \ + lctl-nodemap-set-sepol.8 \ + lctl-snapshot-create.8 \ + lctl-snapshot-destroy.8 \ + lctl-snapshot-list.8 \ + lctl-snapshot-modify.8 \ + lctl-snapshot-mount.8 \ + lctl-snapshot-umount.8 \ + ll_decode_filter_fid.8 \ + llobdstat.8 \ + llog_reader.8 \ + llverdev.8 \ + lshowmount.8 \ + mkfs.lustre.8 \ + mount.lustre_tgt.8 \ + tunefs.lustre.8 + +if MANPAGES +man_MANS = $(LIBMAN) +if SERVER +man_MANS += $(SERVER_MANFILES) +endif -doc.old/%-full.tex: doc.old/%.tex - cd doc.old && $(TEXEXPAND) -texinputs=. -output=$*-full.tex $*.tex +if UTILS +man_MANS += $(MANFILES) +endif +endif -# This rule needs to come after the more specific doc.old rule. -%-full.tex: %.tex - $(TEXEXPAND) -texinputs=. -texinputs=$(srcdir) -output=$@ $< +CLEANFILES = *.aux *.tex *.log *.pdf -# Check out the old directory if it doesn't exist. -doc.old/lustre.lin: - @if test "X$(OLD)" = X; then \ - echo "You must populate doc.old or specify a CVS tag like OLD=v0_5_1"; \ - exit 1; \ - fi - rm -rf doc.old - mkdir doc.old - cvs checkout -r $(OLD) -d doc.old lustre/doc +EXTRA_DIST = $(MANFILES) $(SERVER_MANFILES) $(LIBMAN) -dist-hook: - rm -rf $(distdir)/figs/CVS +all: