[Ovirt-devel] [PATCH docs] Restructured makefile and rpmbuilding to simplify it
Perry Myers
pmyers at redhat.com
Fri Sep 19 05:34:45 UTC 2008
Removed customized rpm macros that should really be set by users
~/.rpmmacros directory. This removed need for custom tar target,
as we can now use dist and rpmbuild -ta instead.
Still need to have custom RPM_FLAGS for ovirt specific overrides
like OVIRT_CACHE_DIR (used by appliance and node-image spec files)
Removed unused bumprelease, bumpversion and setversion targets
Removed other unused make variables
Simplified publish to just rsync all RPMS frpm the rpmdir.
Added seconds granularity to git tag for bumpgit target.
Made it so version file is no longer edited by makefile.
Instead configure.ac file is used to store version. For
developers setting OVIRT_DEV env var causes extra_dist to be
passed to rpmbuild adding the git tag onto the RPM.
Signed-off-by: Perry Myers <pmyers at redhat.com>
---
.gitignore | 21 +++++++-
Makefile | 14 -----
Makefile.am | 44 +++++++++++++++
Using_the_oVirt_Admin_UI/Makefile | 25 ++++++++-
autogen.sh | 58 ++++++++++++++++++++
configure.ac | 11 ++++
oVirt_Installation_Guide/Makefile | 32 +++++++++++
.../en-US/Advanced_Installation.xml | 0
.../en-US/Appliance_Installation.xml | 0
.../en-US/Author_Group.xml | 0
.../en-US/Book_Info.xml | 0
.../en-US/Deploying_Managed_Nodes.xml | 0
.../en-US/Installation_Guide.ent | 0
.../en-US/Installation_Guide.xml | 0
.../en-US/Introduction.xml | 0
.../en-US/Preface.xml | 0
.../en-US/Production_Appliance_Installation.xml | 0
.../en-US/Requirements_and_Support.xml | 0
.../en-US/Revision_History.xml | 0
.../en-US/Upgrading_oVirt.xml | 0
.../en-US/images/icon.svg | 0
ovirt-docs.spec.in | 46 ++++++++++++++++
release.mk | 54 ------------------
src/oVirt_Installation_Guide/Makefile | 15 -----
version | 1 -
25 files changed, 233 insertions(+), 88 deletions(-)
delete mode 100644 Makefile
create mode 100644 Makefile.am
create mode 100755 autogen.sh
create mode 100644 configure.ac
create mode 100644 oVirt_Installation_Guide/Makefile
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Advanced_Installation.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Appliance_Installation.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Author_Group.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Book_Info.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Deploying_Managed_Nodes.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Installation_Guide.ent (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Installation_Guide.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Introduction.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Preface.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Production_Appliance_Installation.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Requirements_and_Support.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Revision_History.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/Upgrading_oVirt.xml (100%)
rename {src/oVirt_Installation_Guide => oVirt_Installation_Guide}/en-US/images/icon.svg (100%)
create mode 100644 ovirt-docs.spec.in
delete mode 100644 release.mk
delete mode 100644 src/oVirt_Installation_Guide/Makefile
delete mode 100644 version
diff --git a/.gitignore b/.gitignore
index 6b4e759..0aad8cf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,20 @@
-rpmbuild
+Makefile
+Makefile.in
+aclocal.m4
+autom4te.cache
+config.h
+config.h.in
+config.log
+config.status
+configure
+depcomp
+install-sh
+missing
+stamp-h1
+ovirt-docs*.gz
+ovirt-docs.spec
+Using_the_oVirt_Admin_UI/publish/
+Using_the_oVirt_Admin_UI/tmp/
+oVirt_Installation_Guide/publish/
+oVirt_Installation_Guide/tmp/
+
diff --git a/Makefile b/Makefile
deleted file mode 100644
index b458ed5..0000000
--- a/Makefile
+++ /dev/null
@@ -1,14 +0,0 @@
-pkg_name = ovirt-docs
-
-all: rpms
-include release.mk
-
-clean:
-
-distclean: clean
- rm -rf rpm-build
-
-tar: clean
- echo "TBD"
-
-.PHONY: all clean distclean tar
diff --git a/Makefile.am b/Makefile.am
new file mode 100644
index 0000000..c699e7d
--- /dev/null
+++ b/Makefile.am
@@ -0,0 +1,44 @@
+# Copyright (C) 2008 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301, USA. A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+OVIRT_CACHE_DIR ?= $(HOME)/ovirt-cache
+
+EXTRA_DIST = \
+ .gitignore \
+ ovirt-docs.spec \
+ ovirt-docs.spec.in \
+ oVirt_Installation_Guide \
+ Using_the_oVirt_Admin_UI
+
+git_head = $$(git log -1 --pretty=format:%h)
+GIT_RELEASE = $$(date --utc +%Y%m%d%H%M%S)git$(git_head)
+RPMDIR = $$(rpm --eval '%{_rpmdir}')
+RPM_FLAGS = --define "ovirt_cache_dir $(OVIRT_CACHE_DIR)"
+RPM_FLAGS += $(if $(OVIRT_DEV),--define "git_release .$(GIT_RELEASE)")
+
+rpms: dist
+ rpmbuild $(RPM_FLAGS) -ta $(distdir).tar.gz
+
+publish: rpms
+ rsync -aq $(shell rpm --eval '%{_rpmdir}')/ $(OVIRT_CACHE_DIR)/ovirt/
+ createrepo $(OVIRT_CACHE_DIR)/ovirt
+
+all:
+ $(MAKE) -C oVirt_Installation_Guide publish-html-all publish-pdf-all
+ $(MAKE) -C Using_the_oVirt_Admin_UI publish-html-all publish-pdf-all
+
+.PHONY: rpms publish
diff --git a/Using_the_oVirt_Admin_UI/Makefile b/Using_the_oVirt_Admin_UI/Makefile
index 963d546..3fb5ec4 100644
--- a/Using_the_oVirt_Admin_UI/Makefile
+++ b/Using_the_oVirt_Admin_UI/Makefile
@@ -1,14 +1,33 @@
-#Makefile for Using_oVirt
+# Copyright (C) 2008 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301, USA. A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+EXTRA_DIST = en-US
XML_LANG = en-US
+DOCNAME = Using_the_oVirt_Admin_UI
+PRODUCT = oVirt
BRAND = oVirt
#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
TRANSLATIONS = $(XML_LANG) $(OTHER_LANGS)
-#CHUNK_FIRST = 0
-#CHUNK_SECTION_DEPTH = 1
+# Extra Parameters start here
+# Extra Parameters stop here
COMMON_CONFIG = /usr/share/publican
include $(COMMON_CONFIG)/make/Makefile.common
diff --git a/autogen.sh b/autogen.sh
new file mode 100755
index 0000000..234141b
--- /dev/null
+++ b/autogen.sh
@@ -0,0 +1,58 @@
+#!/bin/sh
+# Run this to generate configure and Makefile
+
+srcdir=`dirname $0`
+test -z "$srcdir" && srcdir=.
+
+THEDIR=`pwd`
+(
+ cd $srcdir
+ die=0
+
+ (autoconf --version) < /dev/null > /dev/null 2>&1 || {
+ echo
+ echo "You must have autoconf installed."
+ echo "Download the appropriate package for your distribution,"
+ echo "or see http://www.gnu.org/software/autoconf"
+ die=1
+ }
+
+ (libtool --version) < /dev/null > /dev/null 2>&1 || {
+ echo
+ echo "You must have libtool installed."
+ echo "Download the appropriate package for your distribution,"
+ echo "or see http://www.gnu.org/software/libtool"
+ die=1
+ }
+
+ (automake --version) < /dev/null > /dev/null 2>&1 || {
+ echo
+ die=1
+ echo "You must have automake installed."
+ echo "Download the appropriate package for your distribution,"
+ echo "or see http://www.gnu.org/software/automake"
+ }
+
+ test $die = 1 && exit 1
+
+ test -f ovirt-docs.spec.in || {
+ echo "You must run this script in the top-level directory"
+ exit 1
+ }
+
+ if test -z "$*"; then
+ echo "I am going to run ./configure with no arguments - if you wish "
+ echo "to pass any to it, please specify them on the $0 command line."
+ fi
+
+ aclocal
+ autoheader
+ automake --add-missing
+ autoconf
+ ./configure "$@"
+)
+
+if test "x$OBJ_DIR" != x; then
+ mkdir -p "$OBJ_DIR"
+ cd "$OBJ_DIR"
+fi
diff --git a/configure.ac b/configure.ac
new file mode 100644
index 0000000..0c90a8a
--- /dev/null
+++ b/configure.ac
@@ -0,0 +1,11 @@
+AC_INIT([ovirt-docs], [0.93], [ovirt-devel at redhat.com])
+AM_INIT_AUTOMAKE([-Wall -Werror foreign -Wno-portability])
+AC_PROG_CC
+AC_CONFIG_HEADERS([config.h])
+
+# If using gcc and default CFLAGS, enable some warnings.
+test x"$ac_ct_CC:$CFLAGS" = 'xgcc:-g -O2' \
+ && CFLAGS="$CFLAGS -Wshadow -Wall -Werror"
+
+AC_CONFIG_FILES([Makefile])
+AC_OUTPUT(ovirt-docs.spec)
diff --git a/oVirt_Installation_Guide/Makefile b/oVirt_Installation_Guide/Makefile
new file mode 100644
index 0000000..e8cb911
--- /dev/null
+++ b/oVirt_Installation_Guide/Makefile
@@ -0,0 +1,32 @@
+# Copyright (C) 2008 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# 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 for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301, USA. A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+EXTRA_DIST = en-US
+
+XML_LANG = en-US
+DOCNAME = oVirt_Installation_Guide
+PRODUCT = oVirt
+BRAND = oVirt
+
+#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
+TRANSLATIONS = $(XML_LANG) $(OTHER_LANGS)
+
+# Extra Parameters start here
+
+# Extra Parameters stop here
+COMMON_CONFIG = /usr/share/publican
+include $(COMMON_CONFIG)/make/Makefile.common
diff --git a/src/oVirt_Installation_Guide/en-US/Advanced_Installation.xml b/oVirt_Installation_Guide/en-US/Advanced_Installation.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Advanced_Installation.xml
rename to oVirt_Installation_Guide/en-US/Advanced_Installation.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Appliance_Installation.xml b/oVirt_Installation_Guide/en-US/Appliance_Installation.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Appliance_Installation.xml
rename to oVirt_Installation_Guide/en-US/Appliance_Installation.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Author_Group.xml b/oVirt_Installation_Guide/en-US/Author_Group.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Author_Group.xml
rename to oVirt_Installation_Guide/en-US/Author_Group.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Book_Info.xml b/oVirt_Installation_Guide/en-US/Book_Info.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Book_Info.xml
rename to oVirt_Installation_Guide/en-US/Book_Info.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Deploying_Managed_Nodes.xml b/oVirt_Installation_Guide/en-US/Deploying_Managed_Nodes.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Deploying_Managed_Nodes.xml
rename to oVirt_Installation_Guide/en-US/Deploying_Managed_Nodes.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Installation_Guide.ent b/oVirt_Installation_Guide/en-US/Installation_Guide.ent
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Installation_Guide.ent
rename to oVirt_Installation_Guide/en-US/Installation_Guide.ent
diff --git a/src/oVirt_Installation_Guide/en-US/Installation_Guide.xml b/oVirt_Installation_Guide/en-US/Installation_Guide.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Installation_Guide.xml
rename to oVirt_Installation_Guide/en-US/Installation_Guide.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Introduction.xml b/oVirt_Installation_Guide/en-US/Introduction.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Introduction.xml
rename to oVirt_Installation_Guide/en-US/Introduction.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Preface.xml b/oVirt_Installation_Guide/en-US/Preface.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Preface.xml
rename to oVirt_Installation_Guide/en-US/Preface.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Production_Appliance_Installation.xml b/oVirt_Installation_Guide/en-US/Production_Appliance_Installation.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Production_Appliance_Installation.xml
rename to oVirt_Installation_Guide/en-US/Production_Appliance_Installation.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Requirements_and_Support.xml b/oVirt_Installation_Guide/en-US/Requirements_and_Support.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Requirements_and_Support.xml
rename to oVirt_Installation_Guide/en-US/Requirements_and_Support.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Revision_History.xml b/oVirt_Installation_Guide/en-US/Revision_History.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Revision_History.xml
rename to oVirt_Installation_Guide/en-US/Revision_History.xml
diff --git a/src/oVirt_Installation_Guide/en-US/Upgrading_oVirt.xml b/oVirt_Installation_Guide/en-US/Upgrading_oVirt.xml
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/Upgrading_oVirt.xml
rename to oVirt_Installation_Guide/en-US/Upgrading_oVirt.xml
diff --git a/src/oVirt_Installation_Guide/en-US/images/icon.svg b/oVirt_Installation_Guide/en-US/images/icon.svg
similarity index 100%
rename from src/oVirt_Installation_Guide/en-US/images/icon.svg
rename to oVirt_Installation_Guide/en-US/images/icon.svg
diff --git a/ovirt-docs.spec.in b/ovirt-docs.spec.in
new file mode 100644
index 0000000..bd76051
--- /dev/null
+++ b/ovirt-docs.spec.in
@@ -0,0 +1,46 @@
+Summary: The oVirt Documentation
+Name: ovirt-docs
+Version: 0.93
+Release: 0%{?git_release}%{?dist}%{?extra_release}
+Source0: %{name}-%{version}.tar.gz
+License: OPL
+Group: Applications/System
+BuildArch: noarch
+BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-buildroot
+URL: http://www.ovirt.org/
+BuildRequires: publican
+BuildRequires: publican-ovirt
+
+%description
+Provides the documentation for oVirt
+
+%prep
+
+%setup -q
+
+%build
+%configure
+make
+mv oVirt_Installation_Guide/publish/en-US/oVirt_Server_Suite/1.0/html/Installation_Guide oVirt_Server_Suite_Installation_Guide
+mv oVirt_Installation_Guide/publish/en-US/oVirt_Server_Suite/1.0/pdf/Installation_Guide/Installation_Guide.pdf oVirt_Server_Suite_Installation_Guide.pdf
+mv Using_the_oVirt_Admin_UI/publish/en-US/oVirt/0.6/html/Using_oVirt Using_oVirt
+mv Using_the_oVirt_Admin_UI/publish/en-US/oVirt/0.6/pdf/Using_oVirt/Using_oVirt.pdf Using_oVirt.pdf
+
+%install
+%{__rm} -rf %{buildroot}
+mkdir %{buildroot}
+
+%clean
+%{__rm} -rf %{buildroot}
+
+%files
+%defattr(-, root, root, -)
+%doc oVirt_Server_Suite_Installation_Guide
+%doc oVirt_Server_Suite_Installation_Guide.pdf
+%doc Using_oVirt
+%doc Using_oVirt.pdf
+
+%changelog
+* Thu Sep 18 2008 Perry Myers <pmyers at redhat.com> 0.93-0
+- Initial spec creation
+
diff --git a/release.mk b/release.mk
deleted file mode 100644
index 1afd113..0000000
--- a/release.mk
+++ /dev/null
@@ -1,54 +0,0 @@
-# Release/version-related Makefile variables and rules.
-# It expects the including Makefile to define the "pkg_name"
-# variable, as well as a file named "version" in the current directory.
-
-ARCH := $(shell uname -i)
-VERSION := $(shell awk '{ print $$1 }' version)
-RELEASE := $(shell awk '{ print $$2 }' version)
-NEWVERSION = $$(awk 'BEGIN { printf "%.2f", $(VERSION) + .01 }')
-NEWRELEASE = $$(($(RELEASE) + 1))
-X = $$(awk '{ split($$2,r,"."); \
- printf("%d.%d\n", r[1], r[2]+1) }' version)
-git_head = $$(git log -1 --pretty=format:%h)
-GITRELEASE = $(X).$$(date --utc +%Y%m%d%H%M)git$(git_head)
-DIST = $$(rpm --eval '%{dist}')
-
-SPEC_FILE = $(pkg_name).spec
-
-OVIRT_CACHE_DIR ?= $(HOME)/ovirt-cache
-
-NV = $(pkg_name)-$(VERSION)
-RPM_FLAGS = \
- --define "_topdir %(pwd)/rpm-build" \
- --define "_builddir %{_topdir}" \
- --define "_rpmdir %{_topdir}" \
- --define "_srcrpmdir %{_topdir}" \
- --define '_rpmfilename %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm' \
- --define "_specdir %{_topdir}" \
- --define "_sourcedir %{_topdir}" \
- --define "ovirt_cache_dir $(OVIRT_CACHE_DIR)"
-
-bumpgit:
- echo "$(VERSION) $(GITRELEASE)" > version
-
-bumprelease:
- echo "$(VERSION) $(NEWRELEASE)" > version
-
-bumpversion:
- echo "$(NEWVERSION) 1" > version
-
-setversion:
- echo "$(VERSION) $(RELEASE)" > version
-
-new-rpms: bumprelease rpms
-
-rpms: tar
-# rpmbuild $(RPM_FLAGS) -ba $(SPEC_FILE)
-
-publish: rpms
-# rm -f $(OVIRT_CACHE_DIR)/ovirt/$(pkg_name)*
-# mkdir -p $(OVIRT_CACHE_DIR)/ovirt
-# cp -a rpm-build/$(pkg_name)*.rpm $(OVIRT_CACHE_DIR)/ovirt
-# createrepo $(OVIRT_CACHE_DIR)/ovirt
-
-.PHONY: rpms new-rpms publish setversion bumprelease bumpversion bumpgit
diff --git a/src/oVirt_Installation_Guide/Makefile b/src/oVirt_Installation_Guide/Makefile
deleted file mode 100644
index 693e7d8..0000000
--- a/src/oVirt_Installation_Guide/Makefile
+++ /dev/null
@@ -1,15 +0,0 @@
-#Makefile for oVirt_Installation_Guide
-
-XML_LANG = en-US
-DOCNAME = oVirt_Installation_Guide
-PRODUCT = oVirt
-BRAND = oVirt
-
-#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
-
-# Extra Parameters start here
-
-# Extra Parameters stop here
-COMMON_CONFIG = /usr/share/publican
-include $(COMMON_CONFIG)/make/Makefile.common
-
diff --git a/version b/version
deleted file mode 100644
index 187ac7a..0000000
--- a/version
+++ /dev/null
@@ -1 +0,0 @@
-0.92 1
--
1.5.5.1
More information about the ovirt-devel
mailing list