[publican-list] [Bug 489626] Publican no longer allows for numbers in book titles

bugzilla at redhat.com bugzilla at redhat.com
Wed Mar 11 03:50:33 UTC 2009


Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug.


https://bugzilla.redhat.com/show_bug.cgi?id=489626





--- Comment #2 from Jeff Fearn <jfearn at redhat.com>  2009-03-10 23:50:32 EDT ---
(In reply to comment #1)
> +1
> 
> I use numbers in titles for relnotes. In MRG, any books (mostly relnotes)
> released for minor releases (x.y.z) get collapsed into the major release's
> directory (x.y). This means we need to able to specify which minor release the
> book is for. We can't have four books all titled "Release Notes" floating
> around in one directory. Using other naming conventions ("Release Notes
> Security Release"; "Release Notes Enhancement Release") is not only confusing
> for the customer and the maintainer, but also very limited in scope (When you
> already have a "Release Notes Security Release" for 1.1.1, what do you call the
> security release for 1.1.4?).
> 
> </$0.02>
> 
> LKB  

Changing the name (title) for each revision means that users of the Desktop
content will NOT get updated documentation when they upgrade because you are
changing the package name.

---

e.g.

I install version 1.0 of foo + foo-release-notes

I upgrade to foo 1.1; the release notes didn't get updated because the package
name changed and I don't have the renamed package installed. Now the release
notes I'm reading are out of synch with the program.

---

In addition you are going to be incurring an increasing maintenance burden
every z stream release. Each package you ship has to be maintained for 7 years,
and because you are effectively forking the package every Z stream, that is one
more package on your list for the next 7 years.

This scenario is the reason this restriction was introduced. Over time it
creates a massive, ongoing, unavoidable maintenance effort. Do you really want
to have 7 versions of your release notes package in Bugzilla and have to port
fixes between them?

However, there are good reasons for allowing numbers in titles. Isaac, Brian
and I cornered Mike and have this policy changed, so a patched version will be
coming out soon.

I'd seriously reconsider using this facility for the use you specified above.

Cheers, Jeff.

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.




More information about the publican-list mailing list