From 6b48e317b2dbac3794f801020c3199eae13034e6 Mon Sep 17 00:00:00 2001 From: Chris Alfonso Date: Mon, 16 Apr 2012 13:46:58 -0400 Subject: [PATCH] Resolving rpmlint errors and adding man pages. Fixes #67 --- Makefile | 2 +- docs/man/man1/heat-api.1 | 43 +++++++++++++++++++++++++++++++++++++ docs/man/man1/heat-engine.1 | 43 +++++++++++++++++++++++++++++++++++++ docs/man/man1/heat.1 | 4 ++-- heat.spec | 19 ++++++++++++---- heat/cfntools/cfn-hup | 1 + heat/cfntools/cfn-signal | 1 + heat/common/config.py | 1 - heat/common/crypt.py | 1 - 9 files changed, 106 insertions(+), 9 deletions(-) create mode 100644 docs/man/man1/heat-api.1 create mode 100644 docs/man/man1/heat-engine.1 diff --git a/Makefile b/Makefile index 0a24d7e27c..4fb27da569 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ NAME = "heat" ASCII2MAN = a2x -D $(dir $@) -d manpage -f manpage $< ASCII2HTMLMAN = a2x -D docs/html/man/ -d manpage -f xhtml -MANPAGES := docs/man/man1/heat.1 +MANPAGES := docs/man/man1/heat.1 docs/man/man1/heat-engine.1 docs/man/man1/heat-api.1 SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()") RPMVERSION := $(shell awk '/Version/{print $$2; exit}' < heat.spec | cut -d "%" -f1) RPMRELEASE := $(shell awk '/Release/{print $$2; exit}' < heat.spec | cut -d "%" -f1) diff --git a/docs/man/man1/heat-api.1 b/docs/man/man1/heat-api.1 new file mode 100644 index 0000000000..7e07f85c0c --- /dev/null +++ b/docs/man/man1/heat-api.1 @@ -0,0 +1,43 @@ +'\" t +.\" Title: heat +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 03/31/2012 +.\" Manual: System administration commands +.\" Source: Heat 0.0.1 +.\" Language: English +.\" +.TH "HEAT" "1" "03/31/2012" "HEAT 0\&.0\&.1" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +heat-api \- The external api to the heat engine +.SH "SYNOPSIS" +.sp +heat-engine +.SH "DESCRIPTION" +.sp +\fBHeat\fR is the external api to the heat project\&. +.RE +.PP +.SH "INVENTORY" +.sp +The heat api is a services that exposes an external api to the heat-engine service. The communication between the heat-api and heat-engine uses RPC\&. +.SH "AUTHOR" +.sp +See the AUTHORS file for a complete list of contributors\&. +.SH "COPYRIGHT" +.sp +Copyright \(co 2012, Red Hat Inc +.sp +Heat is released under the terms of the ASL 2 License\&. +.sp +Extensive documentation as well as IRC and mailing list info is available on the heat home page: http://heat\&-api\&.org/ diff --git a/docs/man/man1/heat-engine.1 b/docs/man/man1/heat-engine.1 new file mode 100644 index 0000000000..911b13ba7c --- /dev/null +++ b/docs/man/man1/heat-engine.1 @@ -0,0 +1,43 @@ +'\" t +.\" Title: heat +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 03/31/2012 +.\" Manual: System administration commands +.\" Source: Heat 0.0.1 +.\" Language: English +.\" +.TH "HEAT" "1" "03/31/2012" "HEAT 0\&.0\&.1" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +heat-engine \- The heat engine +.SH "SYNOPSIS" +.sp +heat-engine +.SH "DESCRIPTION" +.sp +\fBHeat\fR is the heat project server with an internal api called by the heat-api\&. +.RE +.PP +.SH "INVENTORY" +.sp +The heat engine does all the orchestration work and is the layer in which the resource integration is implemented\&. +.SH "AUTHOR" +.sp +See the AUTHORS file for a complete list of contributors\&. +.SH "COPYRIGHT" +.sp +Copyright \(co 2012, Red Hat Inc +.sp +Heat is released under the terms of the ASL 2 License\&. +.sp +Extensive documentation as well as IRC and mailing list info is available on the heat home page: http://heat\&-api\&.org/ diff --git a/docs/man/man1/heat.1 b/docs/man/man1/heat.1 index 3c59ff74be..4eaeca37fc 100644 --- a/docs/man/man1/heat.1 +++ b/docs/man/man1/heat.1 @@ -44,11 +44,11 @@ The template to use set up a stack\&. Heat orchestrates the setup of multiple cloud applications\&. .SH "AUTHOR" .sp -Heat was originally written by Angus Salkeld\&. See the AUTHORS file for a complete list of contributors\&. +See the AUTHORS file for a complete list of contributors\&. .SH "COPYRIGHT" .sp Copyright \(co 2012, Red Hat Inc .sp Heat is released under the terms of the ASL 2 License\&. .sp -Extensive documentation as well as IRC and mailing list info is available on the heat home page: https://heat\&-project\&.org/ +Extensive documentation as well as IRC and mailing list info is available on the heat home page: https://heat\&-api\&.org/ diff --git a/heat.spec b/heat.spec index c648c56b65..be8cc48dbe 100644 --- a/heat.spec +++ b/heat.spec @@ -7,8 +7,8 @@ Release: 1 License: ASL 2.0 Prefix: %{_prefix} Group: System Environment/Base -URL: http://www.heat-project.org -Source0: http://heat-project.org/downloads/%{name}-%{version}/%{name}-%{version}.tar.gz +URL: http://www.heat-api.org +Source0: http://heat-api.org/downloads/%{name}-%{version}/%{name}-%{version}.tar.gz Requires: pacemaker-cloud @@ -30,7 +30,7 @@ mkdir -p $RPM_BUILD_ROOT/var/lib/heat/ mkdir -p $RPM_BUILD_ROOT/etc/heat/ cp etc/* $RPM_BUILD_ROOT/etc/heat/ mkdir -p $RPM_BUILD_ROOT/%{_mandir}/man1/ -cp -v docs/man/man1/heat.1 $RPM_BUILD_ROOT/%{_mandir}/man1/ +cp -v docs/man/man1/* $RPM_BUILD_ROOT/%{_mandir}/man1/ rm -rf $RPM_BUILD_ROOT/var/lib/heat/.dummy rm -rf $RPM_BUILD_ROOT/%{python_sitelib}/heat/vcsversion.* rm -rf $RPM_BUILD_ROOT/%{python_sitelib}/heat/tests @@ -76,7 +76,7 @@ Group: System Environment/Base Requires: %{name} = %{version}-%{release} %description jeos -This package contains the Just Enough OS configuration files supported by the Heat project +This package contains the Just Enough OS configuration files %package openstack License: ASL 2.0 @@ -102,7 +102,9 @@ This package contains the OpenStack integration for the Heat project %config(noreplace) /etc/heat %files api +%doc README.rst %defattr(-,root,root,-) +%{_mandir}/man1/*.gz %{_bindir}/heat-api %{python_sitelib}/heat/api/__init__.* %{python_sitelib}/heat/api/versions.* @@ -114,6 +116,7 @@ This package contains the OpenStack integration for the Heat project %{_localstatedir}/log/heat/api.log %files common +%doc README.rst %defattr(-,root,root,-) %{python_sitelib}/heat/common/auth.* %{python_sitelib}/heat/common/client.* @@ -127,7 +130,9 @@ This package contains the OpenStack integration for the Heat project %{python_sitelib}/heat/common/wsgi.* %files engine +%doc README.rst %defattr(-,root,root,-) +%{_mandir}/man1/*.gz %{_bindir}/heat-engine %{python_sitelib}/heat/engine/* %{python_sitelib}/heat/openstack/* @@ -140,6 +145,7 @@ This package contains the OpenStack integration for the Heat project %{_localstatedir}/log/heat/engine.log %files jeos +%doc README.rst %defattr(-,root,root,-) %{python_sitelib}/heat/jeos/F16-x86_64-gold-jeos.tdl %{python_sitelib}/heat/jeos/F16-i386-gold-jeos.tdl @@ -151,7 +157,12 @@ This package contains the OpenStack integration for the Heat project %{python_sitelib}/heat/jeos/F17-i386-cfntools-jeos.tdl %files openstack +%doc README.rst %defattr(-,root,root,-) %{python_sitelib}/heat/openstack/__init__.* %{python_sitelib}/heat/openstack/common/cfg.* %{python_sitelib}/heat/openstack/common/__init__.* + +%changelog heat api common engine jeos openstack +* Mon Apr 16 2012 Chris Alfonso - {%version} +- initial openstack package log diff --git a/heat/cfntools/cfn-hup b/heat/cfntools/cfn-hup index 7d72ab93ed..af2411500d 100755 --- a/heat/cfntools/cfn-hup +++ b/heat/cfntools/cfn-hup @@ -1,3 +1,4 @@ +#!/usr/bin/env python # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain diff --git a/heat/cfntools/cfn-signal b/heat/cfntools/cfn-signal index de6283fbd8..0b5029047d 100755 --- a/heat/cfntools/cfn-signal +++ b/heat/cfntools/cfn-signal @@ -1,3 +1,4 @@ +#!/usr/bin/env python # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain diff --git a/heat/common/config.py b/heat/common/config.py index 98e6d8b5c9..252cbe90cd 100644 --- a/heat/common/config.py +++ b/heat/common/config.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # vim: tabstop=4 shiftwidth=4 softtabstop=4 # diff --git a/heat/common/crypt.py b/heat/common/crypt.py index f666fc0cfe..af6a33548b 100644 --- a/heat/common/crypt.py +++ b/heat/common/crypt.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # vim: tabstop=4 shiftwidth=4 softtabstop=4 #