properly document the china option

This commit is contained in:
Ciro Santilli 六四事件 法轮功
2021-04-03 01:00:00 +00:00
parent 5ec6595e1f
commit c7d1528bd7
2 changed files with 19 additions and 1 deletions

View File

@@ -20,8 +20,26 @@ TL;DR: xref:qemu-buildroot-setup-getting-started[xrefstyle=full]
The source code for this page is located at: https://github.com/cirosantilli/linux-kernel-module-cheat[]. Due to https://github.com/isaacs/github/issues/1610[a GitHub limitation], this README is too long and not fully rendered on github.com, so either use: https://cirosantilli.com/linux-kernel-module-cheat or <<build-the-documentation,build the docs yourself>>. The source code for this page is located at: https://github.com/cirosantilli/linux-kernel-module-cheat[]. Due to https://github.com/isaacs/github/issues/1610[a GitHub limitation], this README is too long and not fully rendered on github.com, so either use: https://cirosantilli.com/linux-kernel-module-cheat or <<build-the-documentation,build the docs yourself>>.
image::https://raw.githubusercontent.com/cirosantilli/china-dictatorship-media/master/Xinjiang_prisoners_sitting_identified.jpeg[width=800]
toc::[] toc::[]
== `--china`
The most important functionality of this repository is the `--china` option, sample usage:
....
./setup
./run --china > index.html
firefox index.html
....
see also: https://cirosantilli.com/china-dictatorship/#mirrors
The secondary systems programming functionality is described on the sections below starting from <<getting-started>>.
image::https://raw.githubusercontent.com/cirosantilli/china-dictatorship-media/master/Tiananmen_cute_girls.jpg[width=800]
== Getting started == Getting started
Each child section describes a possible different setup for this repo. Each child section describes a possible different setup for this repo.

View File

@@ -241,7 +241,7 @@ Enable or disable ccache: https://cirosantilli.com/linux-kernel-module-cheat#cca
'--china', '--china',
default=False, default=False,
help='''\ help='''\
To have some fun when the kernel starts to beat you. https://cirosantilli.com/linux-kernel-module-cheat#china
''' '''
) )
self.add_argument( self.add_argument(