Bug 782918 - Provide man page for ipa-upgradeconfig
Summary: Provide man page for ipa-upgradeconfig
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: ipa
Version: 6.3
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Rob Crittenden
QA Contact: IDM QE LIST
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-01-18 20:57 UTC by Dmitri Pal
Modified: 2013-10-07 18:50 UTC (History)
3 users (show)

Fixed In Version: ipa-2.2.0-1.el6
Doc Type: Bug Fix
Doc Text:
No documentation needed.
Clone Of:
Environment:
Last Closed: 2012-06-20 13:29:38 UTC
Target Upstream Version:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2012:0819 0 normal SHIPPED_LIVE ipa bug fix and enhancement update 2012-06-19 20:34:17 UTC

Description Dmitri Pal 2012-01-18 20:57:00 UTC
This bug is created as a clone of upstream ticket:
https://fedorahosted.org/freeipa/ticket/1758

We don't currently ship a man page for ipa-upgradeconfig. It is a simple tool, should be easy to document.

Every utility must have a man page.

Comment 3 Scott Poore 2012-03-30 21:03:34 UTC
Verified.

Version :: ipa-server-2.2.0-5.el6.x86_64

Automated Test Results ::

Unable to run beaker jobs right now for this due to other bugs still being resolved but, I am able to manual run automation check:

# upgrade_bz_782918 

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
:: [   LOG    ] :: upgrade_bz_782918: Provide man page for ipa-upgradeconfig
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

:: [   PASS   ] :: Running 'test -f /usr/share/man/man8/ipa-upgradeconfig.8.gz'
:: [14:58:25] ::  Man page for ipa-upgradeconfig found
:: [   PASS   ] :: BZ 782918 not found
result_server not set, assuming developer mode.
Setting <MASTER_IP> to state upgrade_bz_782918.8
:: [   PASS   ] :: Running 'rhts-sync-set -s 'upgrade_bz_782918.8' -m <MASTER_IP>'

Manual Test Results ::

# ls -l /usr/share/man/man8/ipa-upgradeconfig.8.gz
-rw-r--r--. 1 root root 883 Mar 21 17:17 /usr/share/man/man8/ipa-upgradeconfig.8.gz

# PAGER=cat man ipa-upgradeconfig
ipa-upgradeconfig(8)                                      ipa-upgradeconfig(8)



NAME
       ipa-upgradeconfig - Upgrade the IPA Apache configuration

SYNOPSIS
       ipa-upgradeconfig

DESCRIPTION
       A tool to update the IPA Apache configuration during an upgrade.

       It  examines  the  VERSION  value  in  the  head  of  /etc/httpd/conf.d/ipa.conf  and
       /etc/httpd/conf.d/ipa-rewrite.conf and compares this with the templates. If an update
       is needed then new files are written.

       It  also will convert a CA configured to be accessible via ports 9443, 9444, 9445 and
       9446 to be proxied by the IPA web server on ports 80 and 443.

       This is not intended to be run by an end-user. It is executed when the IPA  rpms  are
       upgraded. This must be run as the root user.

EXIT STATUS
       0 if the update was successful or there was nothing to do

       1 if an error occurred



freeipa                           Sep 9 2010              ipa-upgradeconfig(8)

Comment 5 Martin Kosek 2012-04-20 10:58:47 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
No documentation needed.

Comment 7 errata-xmlrpc 2012-06-20 13:29:38 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHBA-2012-0819.html


Note You need to log in before you can comment on or make changes to this bug.