diff --git a/README.adoc b/README.adoc index ef8f9d7..7dabc96 100644 --- a/README.adoc +++ b/README.adoc @@ -9488,20 +9488,6 @@ These appear when you do `./some-script -h`. We have to keep them as separate files from the README for that to be possible. -==== getvar - -The link:getvar[] helper script prints the value of a variable from the link:common[] file. - -For example, to get the Buildroot output directory for an ARM build, you can use: - -.... -./getvar -a arm buildroot_out_dir -.... - -This script exists mostly to factor out instructions given on the README which users are expected to copy paste into the terminal. - -Otherwise, it becomes very difficult to keep everything working across path refactors, since README snippets cannot be tested automatically. - ==== build .... diff --git a/getvar b/getvar index 97b7e86..60df09f 100755 --- a/getvar +++ b/getvar @@ -1,8 +1,21 @@ #!/usr/bin/env python3 import common -parser = common.get_argparse( - argparse_args={'description':'https://github.com/cirosantilli/linux-kernel-module-cheat#getvar'} -) +parser = common.get_argparse(argparse_args={ + 'description':'''Print the value of a common.py variable. + +This is useful to: + +* give dry commands on the README that don't change when we refactor directory structure +* create simple bash scripts that call use common.py variables + +For example, to get the Buildroot output directory for an ARM build, use: + +.... +./%(prog)s -a arm buildroot_out_dir +.... + +''' +}) parser.add_argument('variable') args = common.setup(parser) print(getattr(common, args.variable))