Red Hat Bugzilla – Bug 123267
Example for filename tag is wrong
Last modified: 2009-07-07 00:08:14 EDT
From Bugzilla Helper:
User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4.1)
Description of problem:
The example given for the <filename> tag incorrectly uses the
<command> tag instead.
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1. View guide.
2. Quiver with confusion.
Actual Results: I was confused, but only for a moment. Thank goodness
Karsten and Tammy are there to steady us! :-)
Expected Results: The example should use the tag it illustrates,
Created attachment 100243 [details]
Patch to fix tags from "command" to "filename"
I'll be in Raleigh 5/16/04 - 5/21/04... would like to buy any FDP members a
tasty beverage of their choice if you're available.
As long as things are getting changed in this section of the docs,
redhat-config-* should probably get replaced with system-config-*
Also, <filename> isn't the correct tag here, since we're not talking
about an actual file name. Perhaps <application> is the best choice
Neither one is a 100% perfect fit. However, the Documentation Guide
explicitly states that <filename> should be used for RPM package
for more info. Since the package itself is not something that is
executable, that's a sensible choice to me, and I'm not in favor of
Ah, you were just trying to fix the inconsistency between the text
written and the actual markup used.
I'm not in favor of using <filename> for rpm package names, because
package names are NOT file names. This has actually bitten folks in
the past, though not Red Hat or Fedora, AFAIK (caused all kind of
confusion for SuSE users of old).
Also, according to TDG, the application tag is for "The name of a
software program." It also suggests that "The appelation
âapplicationâ is usually reserved for larger software packages." I'd
say that in most cases, this applies directly to rpm package names.
Perhaps a role attribute could help clarify this. I'll try to poke
through the archives and see if anything has been discussed previously.
Thanks. Your changes have been made in CVS (file version 1.7).
Ticket moved to allow products to be removed from BZ.