Skip to content

Commit

Permalink
update: fix --tags explanation in --narrow help string
Browse files Browse the repository at this point in the history
For 'git fetch', neither --tags nor --no-tags is the default value. The
default value is a middle ground that fetches "any tag that points into
the histories being fetched is also fetched" - second paragraph in "git
help fetch". Rather than duplicating this relatively non-intuitive git
help in such a small space, be completely transparent about what the
west code does and lead the reader to the original git documentation.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
  • Loading branch information
marc-hb authored and mbolivar-nordic committed Sep 17, 2021
1 parent 8d96e10 commit 38e656b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/west/app/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -767,8 +767,9 @@ def do_add_parser(self, parser_adder):
may be given more than once''')
group.add_argument('-n', '--narrow', action='store_true',
help='''fetch just the project revision if fetching
is necessary; skip fetching tags (may not work for
SHA revisions depending on the Git host)''')
is necessary; do not pass --tags to git fetch
(may not work for SHA revisions depending on the Git
host)''')

group = parser.add_argument_group(
title='checked out branch behavior',
Expand Down

0 comments on commit 38e656b

Please sign in to comment.