458631 - Misalignment in --help command line

Status: RESOLVED FIXED

(Toolkit :: Startup and Profile System, defect)

Description

[Romain BEZUT]

Attachment: patch (with hg up to date)

When I type "myapp --help" or "myapp -h" (works with firefox too), I have something like that :

	-v or -version		Print Firefox version.
	-P <profile>		Start with <profile>.
	-ProfileManager		Start with ProfileManager.
	-no-remote		Open new instance, not a new window in running instance.
	-UILocale <locale>		Start with <locale> resources as UI Locale.
	-safe-mode		Disables extensions and themes for this session.
  -jsconsole           Open the Error console.

There is a misalignment with -jsconsole.

------------------

Patch tested and compiled with the last version of hg (about 15 minutes ago).
Worked successfully on Firefox (did not test with other apps).

Comment 1

[Romain BEZUT]

Attachment: Correction on 2nd alignment

Mmmh, a little mistake that I have not seen before on the 2nd alignment.
Sorry I am a bit tired tonight.

Comment 2

[Philip Chee]

Hmm.
<http://mxr.mozilla.org/comm-central/search?string=helpInfo+%3A&find=&findi=&filter=%5E%5B%5E%5C0%5D*%24&hitlimit=&tree=comm-central>
None of the other javascript based command line handlers use tabs.

Which should the js error console handler be consistent with?

Comment 3

[Philip Chee]

Isn't the display of \t highly dependent on both the OS environment and individual user settings?

Comment 4

[Florian Quèze [:florian]]

(In reply to comment #3)
> Isn't the display of \t highly dependent on both the OS environment and
> individual user settings?

Probably, but IMHO that's why it would be better to display all the options with the same number of tabs or spaces.

The other help messages that are part of the toolkit are displayed with tabs, see:
http://mxr.mozilla.org/mozilla-central/source/toolkit/xre/nsAppRunner.cpp#1174

Comment 5

[Philip Chee]

> Probably, but IMHO that's why it would be better to display all the options
> with the same number of tabs or spaces.

I don't know what you see in comment 0, but none of the lines are aligned on the second column on my browser (not just the error console). Could I suggest that nsAppRunner.cpp be converted to spaces instead?

Comment 6

[Romain BEZUT]

(In reply to comment #5)
> I don't know what you see in comment 0, but none of the lines are aligned on
> the second column on my browser (not just the error console). Could I suggest
> that nsAppRunner.cpp be converted to spaces instead?

Bugzilla does not render the correct alignment, all the options are aligned twice, except -jsconsole.

Change all tabulations by spaces in nsAppRunner.cpp can also be a good idea, but I prefer patching a single line in jsconsole-clhandler.js, than multiple lines (and check for alignment with spaces) in nsAppRunner.cpp.

In any case, we should harmonize that stuff.

Comment 7

[Philip Chee]

> but I prefer patching a single line in jsconsole-clhandler.js
....
> In any case, we should harmonize that stuff.

In that case for consistency you should also patch all the other js command line handlers - in both mozilla-central and in comm-central.

Comment 8

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 341862 [details] [diff] [review]
Correction on 2nd alignment

I think it probably makes more sense to convert nsAppRunner - every other component in the tree seems to use spaces.

Comment 9

[Romain BEZUT]

Attachment: Patch V3

This patch applies to Mozilla-Central.
- It fixes the behavior in nsAppRunner (replacing tabulations with spaces).
- And also fixed extra space(s) in -jsconsole, -browser, -private and -setDefaultBrowser.

If a patch for comm-central is needed please tell me.
Works with Hg updated at the time of this comment, tested on Firefox.

Comment 10

[Marco Bonardo [:mak]]

http://hg.mozilla.org/mozilla-central/rev/a6a223195bf2