Correct a typo in 'cros_workon' and make the command help look nicer

Fix a typo in cros_workon, and make command help output nicer

Details

  The cros_workong help text has a typographic error of 'commond'
  rather than 'command'.  This change addresses that issue.

  The help text output for the list of commands was also not nicely
  aligned, so I've addressed that, too.

Testing

  ~thutt/g-chroot-execute sudo emerge cros-devutils

  After the build & install completed, I executed:

    ~thutt/scripts/g-workon --help

  The output now looks like the following.  The typo was on the
  'iterate' command.

usage: /usr/bin/cros_workon <command> [flags] [<list of packages>|--all]
commands:
  start:     Moves an ebuild to live (intended to support development)
  stop:      Moves an ebuild to stable (use last known good)
  list:      List of live ebuilds (workon ebuilds if --all)
  list-all:  List all of the live ebuilds for all setup boards
  iterate:   For each ebuild, cd to the source dir and run a command
flags:
  --board:  The board to set package keywords for. (default: '')
  --[no]host:  Uses the host instead of board (default: false)
  --command:  The command to be run by forall. (default: 'git status')
  --[no]all:  Apply to all possible packages for the given command (default: false)
  -h,--[no]help:  show this help (default: false)


BUG=0
TEST=See above

Committed: http://chrome-svn/viewvc/chromeos?view=rev&revision=ca61309

[thutt, 2011-04-07 17:22:10]

Hello Mandeep,

Got a change to take a look at this trivial change to cros_workon?

[jrbarnette, 2011-04-07 19:59:03]

LGTM, after one nit.

I'll note that the documentation for iterate doesn't really make clear
how to use the subcommand.  Not your problem, but if you're
feeling generous...

http://codereview.chromium.org/6812022/diff/1/host/cros_workon
File host/cros_workon (right):

http://codereview.chromium.org/6812022/diff/1/host/cros_workon#newcode3
host/cros_workon:3: # Copyright (c) 2010, 2011 The Chromium OS Authors. All
rights reserved.
I think this should be just "Copyright (c) 2011 ..."

[thutt, 2011-04-07 20:24:02]

On 2011/04/07 19:59:03, jrbarnette wrote:
> LGTM, after one nit.
> 
> I'll note that the documentation for iterate doesn't really make clear
> how to use the subcommand.  Not your problem, but if you're
> feeling generous...

I do feel generous, but I don't know what does, or how to use it, so I'll have
to revisit if I ever do use this command.

> http://codereview.chromium.org/6812022/diff/1/host/cros_workon
> File host/cros_workon (right):
> 
> http://codereview.chromium.org/6812022/diff/1/host/cros_workon#newcode3
> host/cros_workon:3: # Copyright (c) 2010, 2011 The Chromium OS Authors. All
> rights reserved.
> I think this should be just "Copyright (c) 2011 ..."

Sadly, you're right.  This will probably still be rejected by our pre-checkin
tests, but it's wrong.  The copyright is supposed to list each year that a file
is modified.  I've filed defect chromium-os:12884 regarding this.

I'll fix.

[Mandeep Singh Baines, 2011-04-07 20:49:12]

LGTM

thutt@chromium.org (thutt@chromium.org) wrote:
> Reviewers: Mandeep Singh Baines,
> 
> Message:
> Hello Mandeep,
> 
> Got a change to take a look at this trivial change to cros_workon?
> 
> 
> Description:
> Fix a typo in cros_workon, and make command help output nicer
> 
> Details
> 
>   The cros_workong help text has a typographic error of 'commond'
>   rather than 'command'.  This change addresses that issue.
> 
>   The help text output for the list of commands was also not nicely
>   aligned, so I've addressed that, too.
> 
> Testing
> 
>   ~thutt/g-chroot-execute sudo emerge cros-devutils
> 
>   After the build & install completed, I executed:
> 
>     ~thutt/scripts/g-workon --help
> 
>   The output now looks like the following.  The typo was on the
>   'iterate' command.
> 
> usage: /usr/bin/cros_workon <command> [flags] [<list of packages>|--all]
> commands:
>   start:     Moves an ebuild to live (intended to support development)
>   stop:      Moves an ebuild to stable (use last known good)
>   list:      List of live ebuilds (workon ebuilds if --all)
>   list-all:  List all of the live ebuilds for all setup boards
>   iterate:   For each ebuild, cd to the source dir and run a command
> flags:
>   --board:  The board to set package keywords for. (default: '')
>   --[no]host:  Uses the host instead of board (default: false)
>   --command:  The command to be run by forall. (default: 'git status')
>   --[no]all:  Apply to all possible packages for the given command (default:
> false)
>   -h,--[no]help:  show this help (default: false)
> 
> 
> BUG=0
> TEST=See above
> 
> 
> Please review this at http://codereview.chromium.org/6812022/
> 
> SVN Base: ssh://gitrw.chromium.org:9222/dev-util.git@master
> 
> Affected files:
>   M host/cros_workon
> 
> 
> Index: host/cros_workon
> diff --git a/host/cros_workon b/host/cros_workon
> index
fc1c365ba825305a694d8ed1fc216ed79a4f7764..e3c86cbcc457d7b5b399a7b01df0734ea07017ef
> 100755
> --- a/host/cros_workon
> +++ b/host/cros_workon
> @@ -1,6 +1,6 @@
>  #!/bin/bash
> 
> -# Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
> +# Copyright (c) 2010, 2011 The Chromium OS Authors. All rights reserved.
>  # Use of this source code is governed by a BSD-style license that can be
>  # found in the LICENSE file.
> 
> @@ -26,11 +26,11 @@ DEFINE_boolean all "${FLAGS_FALSE}" \
> 
>  FLAGS_HELP="usage: $0 <command> [flags] [<list of packages>|--all]
>  commands:
> -  start:  Moves an ebuild to live (intended to support development)
> -  stop:  Moves an ebuild to stable (use last known good)
> -  list:  List of live ebuilds (workon ebuilds if --all)
> +  start:     Moves an ebuild to live (intended to support development)
> +  stop:      Moves an ebuild to stable (use last known good)
> +  list:      List of live ebuilds (workon ebuilds if --all)
>    list-all:  List all of the live ebuilds for all setup boards
> -  iterate:  For each ebuild, cd to the source dir and run a commond"
> +  iterate:   For each ebuild, cd to the source dir and run a command"
>  FLAGS "$@" || { [ "${FLAGS_help}" = "${FLAGS_TRUE}" ]  && exit 0; }
> || exit 1
>  eval set -- "${FLAGS_ARGV}"
> 
> 
> 

[jrbarnette, 2011-04-07 21:14:13]

On 2011/04/07 20:24:02, thutt wrote:
[ ... ]
> > http://codereview.chromium.org/6812022/diff/1/host/cros_workon#newcode3
> > host/cros_workon:3: # Copyright (c) 2010, 2011 The Chromium OS Authors. All
> > rights reserved.
> > I think this should be just "Copyright (c) 2011 ..."
> 
> Sadly, you're right.  This will probably still be rejected by our pre-checkin
> tests, but it's wrong.  The copyright is supposed to list each year that a
file
> is modified.  I've filed defect chromium-os:12884 regarding this.
> 
There was some discussion about this not too long ago; I believe
one of the conclusions was that the copyright header should have
the date only of the most recent modification.

At any rate, this change LGTM!