Indicate defaults in comandline help

[laborg]

Fixes #12682
Fixes #43949
Fixes #36017

• * indicates the default if the options is unspecified
• Fixed a couple of inconsistencies (e.g. use ` instead of ")
• The man page and the command-line-options.md have been updated too

$ ./julia --help

    julia [switches] -- [programfile] [args...]

Switches (a '*' marks the default value, if applicable):

 -v, --version              Display version information
 -h, --help                 Print this message (--help-hidden for more)
 --help-hidden              Uncommon options not shown by `-h`

 --project[={<dir>|@.}]     Set <dir> as the home project/environment
 -J, --sysimage <file>      Start up with the given system image file
 -H, --home <dir>           Set location of `julia` executable
 --startup-file={yes*|no}   Load `JULIA_DEPOT_PATH/config/startup.jl`; if `JULIA_DEPOT_PATH`
                            environment variable is unset, load `~/.julia/config/startup.jl`
 --handle-signals={yes*|no} Enable or disable Julia's default signal handlers
 --sysimage-native-code={yes*|no}
                            Use native code from system image if available
 --compiled-modules={yes*|no}
                            Enable or disable incremental precompilation of modules

 -e, --eval <expr>          Evaluate <expr>
 -E, --print <expr>         Evaluate <expr> and display the result
 -L, --load <file>          Load <file> immediately on all processors

 -t, --threads {N|auto}     Enable N threads; "auto" tries to infer a useful default number
                            of threads to use but the exact behavior might change in the future.
                            Currently, "auto" uses the number of CPUs assigned to this julia
                            process based on the OS-specific affinity assignment interface, if
                            supported (Linux and Windows). If this is not supported (macOS) or
                            process affinity is not configured, it uses the number of CPU
                            threads.
 -p, --procs {N|auto}       Integer value N launches N additional local worker processes
                            "auto" launches as many workers as the number of local CPU threads (logical cores)
 --machine-file <file>      Run processes on hosts listed in <file>

 -i                         Interactive mode; REPL runs and `isinteractive()` is true
 -q, --quiet                Quiet startup: no banner, suppress REPL warnings
 --banner={yes|no|auto*}    Enable or disable startup banner
 --color={yes|no|auto*}     Enable or disable color text
 --history-file={yes*|no}   Load or save history

 --depwarn={yes|no*|error}  Enable or disable syntax and method deprecation warnings (`error` turns warnings into errors)
 --warn-overwrite={yes|no*} Enable or disable method overwrite warnings
 --warn-scope={yes*|no}     Enable or disable warning for ambiguous top-level scope

 -C, --cpu-target <target>  Limit usage of CPU features up to <target>; set to `help` to see the available options
 -O, --optimize={0,1,2*,3}  Set the optimization level (level 3 if `-O` is used without a level)
 --min-optlevel={0*,1,2,3}  Set a lower bound on the optimization level
 -g [{0,1*,2}]              Set the level of debug info generation (level 2 if `-g` is used without a level)
 --inline={yes*|no}         Control whether inlining is permitted, including overriding @inline declarations
 --check-bounds={yes|no|auto*}
                            Emit bounds checks always, never, or respect @inbounds declarations
 --math-mode={ieee,fast}    Disallow or enable unsafe floating point optimizations (overrides @fastmath declaration)

 --code-coverage[={none*|user|all}]
                            Count executions of source lines (omitting setting is equivalent to `user`)
 --code-coverage=tracefile.info
                            Append coverage information to the LCOV tracefile (filename supports format tokens)
 --track-allocation[={none*|user|all}]
                            Count bytes allocated by each source line (omitting setting is equivalent to `user`)
 --bug-report=KIND          Launch a bug report session. It can be used to start a REPL, run a script, or evaluate
                            expressions. It first tries to use BugReporting.jl installed in current environment and
                            fallbacks to the latest compatible BugReporting.jl if not. For more information, see
                            --bug-report=help.

$ ./julia --help-hidden

    julia [switches] -- [programfile] [args...]

Switches (a '*' marks the default value, if applicable):

 --compile={yes*|no|all|min}
                          Enable or disable JIT compiler, or request exhaustive or minimal compilation

 --output-o <name>        Generate an object file (including system image data)
 --output-ji <name>       Generate a system image data file (.ji)
 --strip-metadata         Remove docstrings and source location info from system image
 --strip-ir               Remove IR (intermediate representation) of compiled functions

 --output-unopt-bc <name> Generate unoptimized LLVM bitcode (.bc)
 --output-bc <name>       Generate LLVM bitcode (.bc)
 --output-asm <name>      Generate an assembly file (.s)
 --output-incremental={yes|no*}
                          Generate an incremental output file (rather than complete)
 --trace-compile={stderr,name}
                          Print precompile statements for methods compiled during execution or save to a path
 --image-codegen          Force generate code in imaging mode

[vtjnash]

Can you add a brief note at the top of each of these docs saying that "A '*' marks the default value, if applicable."

[vtjnash]

still draft, or ready for review now?

[laborg]

Its ready for review. Not sure if the CI failures should tell me something.

[IanButterworth]

Marking this for 1.8 backport as I don't see any reason not to, and at least one PR for backport is on top of this