build: align help options

While it's aesthetically nice to start the help message in a new line
looking at the code, the first \n screws the output leaving them not
aligned.
This commit is contained in:
Lucas De Marchi 2018-03-27 00:32:22 -07:00
parent 9342bc5050
commit 73edda697d
3 changed files with 21 additions and 26 deletions

View File

@ -394,18 +394,16 @@ def options(opt):
g.add_option('--program-group',
action='append',
default=[],
help='''
Select all programs that go in <PROGRAM_GROUP>/ for the build. Example: `waf
--program-group examples` builds all examples. The special group "all" selects
all programs.
help='''Select all programs that go in <PROGRAM_GROUP>/ for the build.
Example: `waf --program-group examples` builds all examples. The
special group "all" selects all programs.
''')
g.add_option('--upload',
action='store_true',
help='''
Upload applicable targets to a connected device. Not all platforms may support
this. Example: `waf copter --upload` means "build arducopter and upload it to
my board".
help='''Upload applicable targets to a connected device. Not all
platforms may support this. Example: `waf copter --upload` means "build
arducopter and upload it to my board".
''')
g = opt.ap_groups['check']
@ -418,12 +416,12 @@ my board".
g.add_option('--clean-all-sigs',
action='store_true',
help='''
Clean signatures for all tasks. By default, tasks that scan for implicit
dependencies (like the compilation tasks) keep the dependency information
across clean commands, so that that information is changed only when really
necessary. Also, some tasks that don't really produce files persist their
signature. This option avoids that behavior when cleaning the build.
help='''Clean signatures for all tasks. By default, tasks that scan for
implicit dependencies (like the compilation tasks) keep the dependency
information across clean commands, so that that information is changed
only when really necessary. Also, some tasks that don't really produce
files persist their signature. This option avoids that behavior when
cleaning the build.
''')
def build(bld):

View File

@ -209,9 +209,8 @@ def options(opt):
g.add_option('--summary-all',
action='store_true',
help='''
Print build summary for all targets. By default, only information about the
first %d targets will be printed.
help='''Print build summary for all targets. By default, only
information about the first %d targets will be printed.
''' % MAX_TARGETS)
def configure(cfg):

16
wscript
View File

@ -68,18 +68,17 @@ def options(opt):
dest='autoconfig',
action='store_false',
default=True,
help='''
Disable autoconfiguration feature. By default, the build system triggers a
reconfiguration whenever it thinks it's necessary - this option disables that.
help='''Disable autoconfiguration feature. By default, the build system
triggers a reconfiguration whenever it thinks it's necessary - this
option disables that.
''')
g.add_option('--no-submodule-update',
dest='submodule_update',
action='store_false',
default=True,
help='''
Don't update git submodules. Useful for building with submodules at specific
revisions.
help='''Don't update git submodules. Useful for building with
submodules at specific revisions.
''')
g.add_option('--disable-header-checks', action='store_true',
@ -96,9 +95,8 @@ revisions.
dest='rsync_dest',
action='store',
default='',
help='''
Destination for the rsync Waf command. It can be passed during configuration in
order to save typing.
help='''Destination for the rsync Waf command. It can be passed during
configuration in order to save typing.
''')
g.add_option('--enable-benchmarks',