code-intelligence.com/cifuzz@v0.40.0/third-party/minijail/HACKING.md (about) 1 # Hacking on Minijail 2 3 ## Dependencies 4 5 You'll need these to build the source: 6 * [libcap] 7 * Linux kernel headers 8 9 You'll need to install the relevant packages from your distro. 10 11 ## Building 12 13 For local experimentation (using Minijail libraries from the source directory): 14 15 ``` 16 $ make LIBDIR=/lib64 17 $ sudo ./minijail0.sh -u ${USER} -g 5000 -- /usr/bin/id 18 ``` 19 20 For system-wide usage, install `libminijail.so` and `libminijailpreload.so` to 21 `/lib64` and `minijail0` to a directory in your `PATH` (e.g. `/usr/bin`). 22 23 ## Testing 24 25 We use [Google Test] (i.e. `gtest` & `gmock`) for unit tests. 26 You can download a suitable copy of Google Test using the 27 [get_googletest.sh](./get_googletest.sh) script. 28 29 ``` 30 $ ./get_googletest.sh 31 googletest-release-1.8.0/ 32 ... 33 $ make tests 34 ``` 35 36 Building the tests will automatically execute them. 37 38 ## Code Review 39 40 We use [Android Review] for Minijail code review. The easiest way to submit 41 changes for review is using `repo upload` on a Chromium OS or Android checkout. 42 Go to [Android Review HTTP Credentials] to obtain credentials to push code. For 43 more detailed instructions see the [Android source documentation] or the 44 [Chromium OS documentation]. 45 46 ## Source Style 47 48 * Minijail uses kernel coding style: 49 https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst 50 * Utility functions with no side-effects should go in `util.{h|c}`. 51 * Functions with side effects or with dependencies on operating system 52 details, but that don't take a `struct minijail` argument, should go 53 in `system.{h|c}`. 54 55 ## Documentation 56 57 ### Markdown 58 59 Minijail uses markdown for general/source documentation. 60 We follow the [Google Markdown style guide]. 61 62 ### Man Pages 63 64 For users of Minijail (e.g. `minijail0`), we use man pages. 65 For style guides, check out the [Linux man-pages project] for general guidance. 66 It has a number of useful references for syntax and such. 67 68 * [man-pages(7)](http://man7.org/linux/man-pages/man7/man-pages.7.html) 69 * [groff-man(7)](http://man7.org/linux/man-pages/man7/groff_man.7.html) 70 * [groff(7)](http://man7.org/linux/man-pages/man7/groff.7.html) 71 72 [minijail0.1] documents the command line interface. 73 Please keep it in sync with [minijail0_cli.c]. 74 75 [minijail0.5] documents the syntax of config files (e.g. seccomp filters). 76 77 [libcap]: https://git.kernel.org/pub/scm/linux/kernel/git/morgan/libcap.git/ 78 [minijail0.1]: ./minijail0.1 79 [minijail0.5]: ./minijail0.5 80 [minijail0_cli.c]: ./minijail0_cli.c 81 [Android Review]: https://android-review.googlesource.com/ 82 [Android Review HTTP Credentials]: https://android-review.googlesource.com/settings/#HTTPCredentials 83 [Android source documentation]: https://source.android.com/setup/start 84 [Chromium OS documentation]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_guide.md 85 [Google Markdown style guide]: https://github.com/google/styleguide/blob/gh-pages/docguide/style.md 86 [Google Test]: https://github.com/google/googletest