debian-forge/osbuild
David Rheinsberg 0d8db1c169 osbuild: make parameter identifiers more descriptive
This modifies the help-strings for parameters in `osbuild --help`.
Rather than using the identifier to describe its purpose, make it
describe its type. That is, this changes:

  --sources=SOURCES         =>        --sources=FILE

The option-name should already describe the purpose, so lets use the
argument-name for the type. This also improves on the stuttering when
reading the output.

We already do that for options that take directories as arguments. For
some reasons, we did not do that for options that take file-paths.

It is arguable whether this should be `PATH` or `FILE`. The latter has
the advantage that it makes clear that it is not a directory. It should
be obvious that `FILE` allows all kinds of paths.

Lastly, this does not update the positional arguments (in our case just
`PIPELINE`), since I did not conclude on the best way to make it
self-documenting. `PIPELINE-FILE` sounds convoluted.
2020-03-02 21:33:52 +01:00
..
__init__.py pipeline: return logs in --json mode 2019-12-14 13:49:24 +01:00
__main__.py osbuild: make parameter identifiers more descriptive 2020-03-02 21:33:52 +01:00
api.py api: add barriers 2020-02-06 19:01:12 +01:00
buildroot.py buildroot: allow customizing the backing store for /var 2020-01-27 15:51:47 +01:00
loop.py loop: explicitly close fds to loop devices 2020-01-19 22:19:25 +01:00
objectstore.py objectstore: use a context also for Object.write 2020-02-29 01:14:24 +01:00
pipeline.py pipeline: detect_os() -> describe_os() 2020-02-29 12:35:19 +01:00
remoteloop.py remoteloop: drop O_DIRECT 2020-02-06 19:01:12 +01:00
sources.py sources: add org.osbuild.files source 2020-02-06 19:01:12 +01:00
tmpfs.py osbuild: split package into separate files 2019-08-21 09:56:50 +04:00
treesum.py treesum: don't use dir_fd parameter in os.scandir() 2019-11-29 00:45:14 +01:00