Bug 456488

Summary: Description of product-number and issue-number are incomplete
Product: [Community] Publican Reporter: Joshua Wulf <jwulf>
Component: publicanAssignee: Joshua Wulf <jwulf>
Status: CLOSED CURRENTRELEASE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: low    
Version: 1.6CC: lcarlon, mmcallis, publican-list
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: 0.34 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-07-24 21:23:24 EDT Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:

Description Joshua Wulf 2008-07-23 21:56:01 EDT
Currently:  <productnumber>  product-number  </productnumber>

    replace product-number with the product number. The product number changes
the release number (the last digit) when building a book with the tar or srpm
options. For example, setting the product number to 1 and building the book
using the make srpm-en-US command, would create an RPM file named PRODUCT -
DOCNAME -0.0-1.src.rpm. PRODUCT and DOCNAME are configured in the Makefile. 


Suggestion:

replace product-number with the edition (release) number of the book. The first
edition should be 1.0. Subsequent revisions should increment the 1.x to indicate
to readers that it is a revised edition.

Current:

  <issuenum>  issue-number  </issuenum>

    replace issue-number with the issue number. The issue number changes the
version number (the first two digits) when building a book with the tar or srpm
options. 

Suggested:

replace issue-number with the version number of the product the book applies to
(e.g: 5.1 for RHEL 5.1, 4.3 for JBoss EAP 4.3). If your book does not apply to a
product then put whatever you like.