[Bug general/5810] New: inconsistent help output

[Bug general/5810] New: inconsistent help output

[tromey at redhat dot com]

I looked through the 'help' output a bit.

With plain 'help', some descriptions start with a capital letter,
but some do not.  Some end with a period, but some do not.
Some have extremely minimal short descriptions, like: "load - load".

Looking at specific commands' help, there are more inconsistencies.
load says: [ -sysroot Path ]
display: display expr
where: [ {num-levels ]
disassemble: disassemble  [startAddress] [--] [OPTIONS]||
disassemble  <startAddress> <endAddress> [--] [-OPTIONS] -option ...; 
  (disassemble is inconsistent with itself)

That is -- "metasyntactic variables" are written in a number of different ways.
It would be better to just have one way.

Sometimes the "short help" prints after the description (quit, one other
I can't find right now), but mostly before.

Finally, some descriptions use two spaces after a sentence, but
some use one.

-- 
           Summary: inconsistent help output
           Product: frysk
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: general
        AssignedTo: frysk-bugzilla at sourceware dot org
        ReportedBy: tromey at redhat dot com


http://sourceware.org/bugzilla/show_bug.cgi?id=5810

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug general/5810] inconsistent help output

[tromey at redhat dot com]

------- Additional Comments From tromey at redhat dot com  2008-03-01 22:22 -------
I've also noticed that some help mentions both the singular and plural
for various objects of the verb in question.
This makes the word-wrapping look a bit weird sometimes.
Also, it is hard to read.
I think it would be preferable to just pick singular or plural and go with it.


-- 


http://sourceware.org/bugzilla/show_bug.cgi?id=5810

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.