[tor-bugs] #33023 [Core Tor/Chutney]: Chutney 'bootstrap-network.sh' starts a different default network flavor than listed in the usage comments

[Tor Bug Tracker & Wiki]

#33023: Chutney 'bootstrap-network.sh' starts a different default network flavor
than listed in the usage comments
--------------------+----------------------------------
 Reporter:  opara   |          Owner:  (none)
     Type:  defect  |         Status:  new
 Priority:  Low     |      Component:  Core Tor/Chutney
  Version:          |       Severity:  Minor
 Keywords:          |  Actual Points:
Parent ID:          |         Points:
 Reviewer:          |        Sponsor:
--------------------+----------------------------------
 Small documentation problem in Chutney's {{{bootstrap-network.sh}}}.

 The usage comment says the following:

 {{{
 # Usage:
 #    tools/bootstrap-network.sh [network-flavour]
 #    network-flavour: one of the files in the networks directory,
 #                     (default: 'basic')
 }}}

 but the actual code says the following:

 {{{
 # Set the variables for the chutney network flavour
 export NETWORK_FLAVOUR=${NETWORK_FLAVOUR:-"bridges+hs-v2"}
 [ -n "$1" ] && { NETWORK_FLAVOUR=$1; shift; }
 export CHUTNEY_NETWORK="$CHUTNEY_PATH/networks/$NETWORK_FLAVOUR"
 }}}

 As you can see, the comments say that the default network is 'basic', but
 the code actually starts 'bridges+hs-v2'. Reference:
 https://github.com/torproject/chutney/blob/5a9271104fec6c5b9bb23d2574596dc9d7c0a2c4/tools
 /bootstrap-network.sh

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33023>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online