3rd-party/linux-kernel-module-cheat
1
0
Fork 0
mirror of https://github.com/cirosantilli/linux-kernel-module-cheat.git synced 2026-01-29 13:04:27 +01:00
Code Issues Releases Wiki Activity

getvar: move docs to --help

Browse Source
This commit is contained in:
Ciro Santilli
2018-08-31 15:49:00 +01:00
parent 0ea6a2ef5d
commit 1c0b6eb21c
2 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.adoc
View File

@@ -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. 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 ==== build
.... ....

19
getvar
View File

@@ -1,8 +1,21 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
import common import common
parser = common.get_argparse( parser = common.get_argparse(argparse_args={
argparse_args={'description':'https://github.com/cirosantilli/linux-kernel-module-cheat#getvar'} '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') parser.add_argument('variable')
args = common.setup(parser) args = common.setup(parser)
print(getattr(common, args.variable)) print(getattr(common, args.variable))