bob-[dev, build] manpage: improve command syntax descriptions

[icedieler]

Unify the description of the option syntax. Add the long option where one is available.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.97%. Comparing base (c8a6f87) to head (cb94a1a).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #653   +/-   ##
=======================================
  Coverage   88.97%   88.97%           
=======================================
  Files          50       50           
  Lines       16116    16116           
=======================================
  Hits        14340    14340           
  Misses       1776     1776           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jkloetzke]

The synopsis of the manpages is a verbatim copy of the respective output of bob <command> -h | cat. I would like to keep it this way, even if we do not show the long variant of arguments with short options. Otherwise, keeping the synopsis in sync will get increasingly harder.

[jkloetzke]

We should not just manually fix the documentation but also the help text (bob build -h). For that, the argparse module allows to set the "metavar". You could add metavar="VAR=VALUE" to the relevant arguments in pym/bob/cmds/build/build.py. That way also the online help text is correct.

[icedieler]

Thanks @jkloetzke for the helpful review. In the new pull request I made sure to have both the command help and the manpage in sync and at least don't worsen the situation.

[jkloetzke]

Thanks!