1542836 - Format -MOZ_LOG and -MOZ_LOG_FILE flag descriptions according to recommendation

Status: RESOLVED FIXED

(Core :: XPCOM, defect, P1)

Description

[Andreas Tolfsen ❲:ato❳]

nsICommandLineHandler recommends that flags’ help descriptions
should not exceed 76 characters including the newline character.
The -MOZ_LOG and -MOZ_LOG_FILE flags exceed this, making the
output uneven:

% ./mach run -- -h
 0:00.40 /home/ato/src/gecko/obj-x86_64-pc-linux-gnu/dist/bin/firefox -h -no-remote -profile /home/ato/src/gecko/obj-x86_64-pc-linux-gnu/tmp/profile-default
Usage: /home/ato/src/gecko/obj-x86_64-pc-linux-gnu/dist/bin/firefox [ options ... ] [URL]
       where options include:

X11 options
  --display=DISPLAY  X display to use
  --sync             Make X calls synchronous
  --g-fatal-warnings Make all warnings fatal

Firefox options
  -h or --help       Print this message.
  -v or --version    Print Firefox version.
  -P <profile>       Start with <profile>.
  --profile <path>   Start with profile at <path>.
  --migration        Start with migration wizard.
  --ProfileManager   Start with ProfileManager.
  --no-remote        Do not accept or send remote commands; implies
                     --new-instance.
  --new-instance     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.
  --allow-downgrade  Allows downgrading a profile.
  -MOZ_LOG=<modules> Treated as MOZ_LOG=<modules> environment variable, overrides it.
  -MOZ_LOG_FILE=<file> Treated as MOZ_LOG_FILE=<file> environment variable, overrides it.
                     If MOZ_LOG_FILE is not specified as an argument or as an environment variable,
                     logging will be written to stdout.
  --headless         Run without a GUI.
  --save-recordings  Save recordings for all content processes to a directory.
  --browser          Open a browser window.
  --new-window <url> Open <url> in a new window.
  --new-tab <url>    Open <url> in a new tab.
  --private-window <url> Open <url> in a new private window.
  --preferences      Open Preferences dialog.
  --screenshot [<path>] Save screenshot to <path> or in working directory.
  --window-size width[,height] Width and optionally height of screenshot.
  --search <term>    Search <term> with your default search engine.
  --setDefaultBrowser Set this app as the default browser.
  --jsconsole        Open the Browser Console.
  --jsdebugger       Open the Browser Toolbox.
  --wait-for-jsdebugger Spin event loop until JS debugger connects.
                     Enables debugging (some) application startup code paths.
                     Only has an effect when `--jsdebugger` is also supplied.
  --devtools         Open DevTools on initial load.
  --start-debugger-server [ws:][ <port> | <path> ] Start the debugger server on
                     a TCP port or Unix domain socket path. Defaults to TCP port
                     6000. Use WebSocket protocol if ws: prefix is specified.
  --recording <file> Record drawing for a given URL.
  --recording-output <file> Specify destination file for a drawing recording.
  --remote-debugger [<host>][:<port>]
  --remote-debugging-port <port> Start the Firefox remote agent, which is 
                     a low-level debugging interface based on the CDP protocol.
                     Defaults to listen on localhost:9222.

Comment 1

[Andreas Tolfsen ❲:ato❳]

Attachment: bug 1542836: toolkit/xre: format --MOZ_LOG and --MOZ_LOG_FILE help text;

Produces a help text that conforms to the line width recommendations
of nsICommandLine.

On the other hand, the formatting of the source code itself is
rendered rather ugly by clang-format.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/59ae6dc11ba3
toolkit/xre: format --MOZ_LOG and --MOZ_LOG_FILE help text; r=erahm

Comment 3

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/59ae6dc11ba3