Bug 923511 - User Guide says packages built for RHEL5 by default, which is incorrect
Summary: User Guide says packages built for RHEL5 by default, which is incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Publican
Classification: Community
Component: Publican Users Guide
Version: 3.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
Assignee: Zac Dover
QA Contact: tools-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-03-20 02:09 UTC by Katie Miller
Modified: 2015-02-08 21:35 UTC (History)
6 users (show)

Fixed In Version: 3.2.0
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-08-09 04:47:09 UTC
Embargoed:


Attachments (Terms of Use)

Description Katie Miller 2013-03-20 02:09:05 UTC
Description of problem:

The User Guide says in three places in Chapter 7 that:

"Note that by default, Publican generates an RPM package to install on a server that runs Red Hat Enterprise Linux 5."

It suggests you set the os_ver parameter to alter this behaviour.

This does not match up with what Publican (3.1.5) actually does though; it builds the package for whatever OS you are running when you build it.

Version-Release number of selected component (if applicable): 3.0

How reproducible:

Steps to Reproduce:
1. Open document and go to Chapter 7
2. Search for string "Red Hat Enterprise Linux 5"
3. View three places where this information is included (sections 7.2.2, 7.2.3 and 7.2.4)
  
Actual results:


Expected results:


Additional info:

Comment 2 Zac Dover 2013-07-11 07:24:01 UTC

*** This bug has been marked as a duplicate of bug 861794 ***

Comment 3 Zac Dover 2013-07-12 01:12:07 UTC
7.2.2. Creating, installing, and updating the home page
Original
--------
  Note that by default, Publican generates an RPM package to install on 
  a server that runs Red Hat Enterprise Linux 5. To build an RPM package 
  to install on a server that runs a different operating system, set the 
  os_ver parameter in the home page's publican.cfg file. 

Update
------
  By default, Publican builds the RPM package for the operating system 
  within which you are running Publican. To build an RPM package to install 
  on a server that runs a different operating system, set the os_ver 
  parameter in the home page's publican.cfg file. 


7.2.3. Creating, installing, and updating product pages and version pages
Original
--------
  Publican builds an RPM package and places it in the /tmp/rpms/noarch/
  directory of the product page or version page. Note that by default, 
  Publican generates an RPM package to install on a server that runs 
  Red Hat Enterprise Linux 5. To build an RPM package to install on a 
  server that runs a different operating system, set the os_ver parameter 
  in the publican.cfg file of the product page or version page. 

Update
------
  Publican builds an RPM package and places it in the /tmp/rpms/noarch/
  directory of the product page or version page. By default, Publican builds 
  the RPM package for the operating system within which you are running
  Publican. To build an RPM package to install on a server that runs a
  different operating system, set the os_ver parameter in the publican.cfg 
  file of the product page or version page.


7.2.4. Installing, updating and removing documents
Original
--------
  Publican builds an RPM package and places it in the /tmp/rpms/noarch/
  directory of the document. Note that by default, Publican generates an 
  RPM package to install on a server that runs Red Hat Enterprise Linux 5. 
  To build an RPM package to install on a server that runs a different 
  operating system, set the os_ver parameter in the document's 
  publican.cfg file. 

Update
------
  Publican builds an RPM package and places it in the /tmp/rpms/noarch/
  directory of the document. By default, Publican builds the RPM package 
  for the operating system within which you are running Publican. To build 
  an RPM package to install on a server that runs a different operating 
  system, set the os_ver parameter in the document's publican.cfg file. 



One more relevant instance appears here:

publican.cfg parameters:
  os_ver
      the operating system for which to build packages. (Default: .el5 — Red
      Hat Enterprise Linux 5)

I have changed this to:
  os_ver
    the operating system for which to build packages.

Git commit
----------
eaa944f..84346f5

Comment 4 Misha H. Ali 2013-08-07 05:59:54 UTC
(In reply to Zac Dover from comment #3)
> 7.2.2. Creating, installing, and updating the home page
> Original
> --------
>   Note that by default, Publican generates an RPM package to install on 
>   a server that runs Red Hat Enterprise Linux 5. To build an RPM package 
>   to install on a server that runs a different operating system, set the 
>   os_ver parameter in the home page's publican.cfg file. 
> 
> Update
> ------
>   By default, Publican builds the RPM package for the operating system 
>   within which you are running Publican. To build an RPM package to install 
>   on a server that runs a different operating system, set the os_ver 
>   parameter in the home page's publican.cfg file. 
> 

Verified in 7.2.2. 

> 
> 7.2.3. Creating, installing, and updating product pages and version pages
> Original
> --------
>   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
>   directory of the product page or version page. Note that by default, 
>   Publican generates an RPM package to install on a server that runs 
>   Red Hat Enterprise Linux 5. To build an RPM package to install on a 
>   server that runs a different operating system, set the os_ver parameter 
>   in the publican.cfg file of the product page or version page. 
> 
> Update
> ------
>   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
>   directory of the product page or version page. By default, Publican builds 
>   the RPM package for the operating system within which you are running
>   Publican. To build an RPM package to install on a server that runs a
>   different operating system, set the os_ver parameter in the publican.cfg 
>   file of the product page or version page.

Verified in 7.2.3. A space is missing within this paragraph after the period that ends the first sentence and the beginning of the second one. Currently, the PDF version renders as follows:

"... directory of the product page or version page.By default, Publican builds ..."

> 
> 7.2.4. Installing, updating and removing documents
> Original
> --------
>   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
>   directory of the document. Note that by default, Publican generates an 
>   RPM package to install on a server that runs Red Hat Enterprise Linux 5. 
>   To build an RPM package to install on a server that runs a different 
>   operating system, set the os_ver parameter in the document's 
>   publican.cfg file. 
> 
> Update
> ------
>   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
>   directory of the document. By default, Publican builds the RPM package 
>   for the operating system within which you are running Publican. To build 
>   an RPM package to install on a server that runs a different operating 
>   system, set the os_ver parameter in the document's publican.cfg file. 
> 

Verified in 7.2.4.

> 
> 
> One more relevant instance appears here:
> 
> publican.cfg parameters:
>   os_ver
>       the operating system for which to build packages. (Default: .el5 — Red
>       Hat Enterprise Linux 5)
> 
> I have changed this to:
>   os_ver
>     the operating system for which to build packages.

Verified in "publican.cfg parameters".

Comment 5 Zac Dover 2013-08-07 07:53:08 UTC
(In reply to Misha H. Ali from comment #4)

> > 7.2.3. Creating, installing, and updating product pages and version pages
> > Original
> > --------
> >   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
> >   directory of the product page or version page. Note that by default, 
> >   Publican generates an RPM package to install on a server that runs 
> >   Red Hat Enterprise Linux 5. To build an RPM package to install on a 
> >   server that runs a different operating system, set the os_ver parameter 
> >   in the publican.cfg file of the product page or version page. 
> > 
> > Update
> > ------
> >   Publican builds an RPM package and places it in the /tmp/rpms/noarch/
> >   directory of the product page or version page. By default, Publican builds 
> >   the RPM package for the operating system within which you are running
> >   Publican. To build an RPM package to install on a server that runs a
> >   different operating system, set the os_ver parameter in the publican.cfg 
> >   file of the product page or version page.
> 
> Verified in 7.2.3. A space is missing within this paragraph after the period
> that ends the first sentence and the beginning of the second one. Currently,
> the PDF version renders as follows:
> 
> "... directory of the product page or version page.By default, Publican
> builds ..."

That is one hell of a line edit, Misha.

I have added the space between the period at the end of the sentence ending "page." and the beginning of the sentence beginning "By default,".

It looks like this now:

  Publican builds an RPM package and places it in the /tmp/rpms/noarch/
  directory of the product page or version page. By default, Publican builds
  the RPM package for the operating system within which you are running 
  Publican. 

committed to
f1ffc57..dc4d0f4  devel -> devel

Comment 6 Misha H. Ali 2013-08-07 23:47:30 UTC
Verified space between period and subsequent sentence in updated doc.

Comment 7 Jeff Fearn 🐞 2013-08-09 04:47:09 UTC
The fix for this bug has been shipped in publican 3.2.0


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