From 1c6e9b79ab4d7705bd85241e54923d6d514f58f3 Mon Sep 17 00:00:00 2001 From: Jan Olszak Date: Wed, 22 Jul 2015 15:18:09 +0200 Subject: [PATCH] Main page in Markdown format [Feature] N/A [Cause] N/A [Solution] N/A [Verification] ./generate_documentation.sh and verify Change-Id: I6b4f55de7f48bb66b3dd40a2313b6137919f028f --- doc/custom.css | 2 +- doc/doxygen.cfg | 10 +++++----- doc/mainpage.dox | 12 ------------ doc/mainpage.md | 17 +++++++++++++++++ 4 files changed, 23 insertions(+), 18 deletions(-) delete mode 100644 doc/mainpage.dox create mode 100644 doc/mainpage.md diff --git a/doc/custom.css b/doc/custom.css index 301ee53..726b998 100644 --- a/doc/custom.css +++ b/doc/custom.css @@ -1,7 +1,7 @@ /* The standard CSS for doxygen 1.8.6 */ body, table, div, p, dl { - font: 400 14px/22px Roboto,sans-serif; + font: 400 16px/24px Roboto,sans-serif; } /* @group Heading Levels */ diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index 99e7685..40e7b49 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -743,11 +743,11 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = ../common \ - ../client \ - ../server \ - ../cli \ - mainpage.dox +INPUT = ../common \ + ../client \ + ../server \ + ../cli \ + mainpage.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/doc/mainpage.dox b/doc/mainpage.dox deleted file mode 100644 index b3b7f34..0000000 --- a/doc/mainpage.dox +++ /dev/null @@ -1,12 +0,0 @@ -/** - * @mainpage Vasum - * - * Vasum is an environment separation mechanism based on Linux Containers (LXC). The idea behind - * the project is to easily create separate environments (for example Tizen operating systems) - * running on one physical device. What differs Vasum from other currently available environment - * separation mechanisms is its ease of use - Vasum comes with pre-defined templates to easily - * create new environments, and high configurability. - * - * For now Vasum uses LXC for Linux Containers management. The project is mostly written in modern - * C++ and is well tested. - */ diff --git a/doc/mainpage.md b/doc/mainpage.md new file mode 100644 index 0000000..74635db --- /dev/null +++ b/doc/mainpage.md @@ -0,0 +1,17 @@ +Introduction {#mainpage} +============ + +[Vasum](https://wiki.tizen.org/wiki/Security:Vasum) is a Linux daemon and a set of utilities used for managing para-virtualization. It uses Linux Containers to create separate, graphical environments called the *zones*. One can concurrently run several zones on one physical device. Vasum exports a rich C/DBus API that the application frameworks can use to interact with zones. + + +For now Vasum uses [LXC](https://linuxcontainers.org/lxc/introduction/) for Linux Containers management. The project is mostly written in modern C++ and is [well tested](https://wiki.tizen.org/wiki/Weekly_test_results_for_Tizen_3.X_security_framework). + +Vasum's development takes place on [review.tizen.org/gerrit/](http://review.tizen.org/gerrit/) (registration on [tizen.org](http://tizen.org) is required). + +## Installation and usage + +The installation process and simple verification is described [here](https://wiki.tizen.org/wiki/Security:Vasum:Usage "Vasum on Tizen"). + +## API + +Vasum daemon can be accessed via C API or DBus. You can find the API documentation [here](https://wiki.tizen.org/wiki/Security:Vasum:API). Be aware that the API will most likely change in the near future. -- 2.7.4