• Alberto Donizetti's avatar
    cmd/compile: better formatting for ssa phases options doc · 8a958bb8
    Alberto Donizetti authored
    Change the help doc of
    
      go tool compile -d=ssa/help
    
    from this:
    
      compile: GcFlag -d=ssa/<phase>/<flag>[=<value>|<function_name>]
      <phase> is one of:
      check, all, build, intrinsics, early_phielim, early_copyelim
      early_deadcode, short_circuit, decompose_user, opt, zero_arg_cse
      opt_deadcode, generic_cse, phiopt, nilcheckelim, prove, loopbce
      decompose_builtin, softfloat, late_opt, generic_deadcode, check_bce
      fuse, dse, writebarrier, insert_resched_checks, tighten, lower
      lowered_cse, elim_unread_autos, lowered_deadcode, checkLower
      late_phielim, late_copyelim, phi_tighten, late_deadcode, critical
      likelyadjust, layout, schedule, late_nilcheck, flagalloc, regalloc
      loop_rotate, stackframe, trim
      <flag> is one of on, off, debug, mem, time, test, stats, dump
      <value> defaults to 1
      <function_name> is required for "dump", specifies name of function to dump after <phase>
      Except for dump, output is directed to standard out; dump appears in a file.
      Phase "all" supports flags "time", "mem", and "dump".
      Phases "intrinsics" supports flags "on", "off", and "debug".
      Interpretation of the "debug" value depends on the phase.
      Dump files are named <phase>__<function_name>_<seq>.dump.
    
    To this:
    
      compile: PhaseOptions usage:
    
          go tool compile -d=ssa/<phase>/<flag>[=<value>|<function_name>]
    
      where:
    
      - <phase> is one of:
          check, all, build, intrinsics, early_phielim, early_copyelim
          early_deadcode, short_circuit, decompose_user, opt, zero_arg_cse
          opt_deadcode, generic_cse, phiopt, nilcheckelim, prove
          decompose_builtin, softfloat, late_opt, generic_deadcode, check_bce
          branchelim, fuse, dse, writebarrier, insert_resched_checks, lower
          lowered_cse, elim_unread_autos, lowered_deadcode, checkLower
          late_phielim, late_copyelim, tighten, phi_tighten, late_deadcode
          critical, likelyadjust, layout, schedule, late_nilcheck, flagalloc
          regalloc, loop_rotate, stackframe, trim
    
      - <flag> is one of:
          on, off, debug, mem, time, test, stats, dump
    
      - <value> defaults to 1
    
      - <function_name> is required for the "dump" flag, and specifies the
        name of function to dump after <phase>
    
      Phase "all" supports flags "time", "mem", and "dump".
      Phase "intrinsics" supports flags "on", "off", and "debug".
    
      If the "dump" flag is specified, the output is written on a file named
      <phase>__<function_name>_<seq>.dump; otherwise it is directed to stdout.
    
    Also add a few examples at the bottom.
    
    Fixes #20349
    
    Change-Id: I334799e951e7b27855b3ace5d2d966c4d6ec4cff
    Reviewed-on: https://go-review.googlesource.com/110062Reviewed-by: 's avatarJosh Bleecher Snyder <josharian@gmail.com>
    8a958bb8
compile.go 14.4 KB