]> review.fuel-infra Code Review - openstack-build/heat-build.git/commitdiff
Resolving rpmlint errors and adding man pages.
authorChris Alfonso <calfonso@redhat.com>
Mon, 16 Apr 2012 17:46:58 +0000 (13:46 -0400)
committerChris Alfonso <calfonso@redhat.com>
Mon, 16 Apr 2012 17:46:58 +0000 (13:46 -0400)
Fixes #67

Makefile
docs/man/man1/heat-api.1 [new file with mode: 0644]
docs/man/man1/heat-engine.1 [new file with mode: 0644]
docs/man/man1/heat.1
heat.spec
heat/cfntools/cfn-hup
heat/cfntools/cfn-signal
heat/common/config.py
heat/common/crypt.py

index 0a24d7e27c3da1a39b7dd7d5e82288c6822b01f2..4fb27da569fa7b1f26b536c8143fcf2adb36fb32 100644 (file)
--- 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 (file)
index 0000000..7e07f85
--- /dev/null
@@ -0,0 +1,43 @@
+'\" t
+.\"     Title: heat 
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      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 (file)
index 0000000..911b13b
--- /dev/null
@@ -0,0 +1,43 @@
+'\" t
+.\"     Title: heat 
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      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/
index 3c59ff74be05b5863505356f0d2b39b3a78c2e75..4eaeca37fc9ea04bc3c4bf1a97d4206fabe159f0 100644 (file)
@@ -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/
index c648c56b651c9dfb54d6e6ee5facbaf379ccb8d1..be8cc48dbe53a6cbb3f1503c321b5673e1798cf2 100644 (file)
--- 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 <calfonso@redhat.com> - {%version}
+- initial openstack package log
index 7d72ab93ede31a66b255cf5f6e368fdf5c169044..af2411500dbcc468524208cfd334c74025ade5b6 100755 (executable)
@@ -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
index de6283fbd848781973deefd3f0319b51ef0c25a7..0b5029047d60724686237d6bfc4831c0580ad3c6 100755 (executable)
@@ -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
index 98e6d8b5c9122a4a3c3a5309e85c21d6d198c643..252cbe90cdedcf952849443c2c420b8d5da977b2 100644 (file)
@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
 #
index f666fc0cfe9e42458d8cca97be391d6b7c0d4bbf..af6a33548bf2b12d7e3811d0c2331dde44429bbf 100644 (file)
@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # vim: tabstop=4 shiftwidth=4 softtabstop=4
 
 #