zephyr

History

Fabrice Olivero 128dcbbe13 kernel event logger: add possibility to use custom timestamp By default, kernel event logger is using the system timer. But on some platforms where the timer driver maintains the system timer cycle accumulator in software, such as ones using the LOAPIC timer, the system timer behavior leads to timestamp errors. For example, the timer interrupt is logged with a wrong timestamp since the HW timer value has been reset (periodic mode) but accumulated value not updated yet (done later in the ISR). This patch is adding the possibility to register a timer callback function that will be used by the kernel event logger. For example, on Quark SE, this allows using RTC or AON counter which accuracy is sufficient and behavior more straight forward compared to system timer. Change-Id: I754c7557350ef29fc10701e62a35a5425e035f11 Signed-off-by: Fabrice Olivero <fabrice.olivero@intel.com>		2016-05-23 21:27:49 +00:00
..
api	doc: Restructure top level sections.	2016-05-21 21:22:46 +00:00
application	doc: fix path to samples after restructering	2016-02-11 13:08:44 -05:00
bluetooth	Bluetooth: doc: Add L2CAP PICS file	2016-02-16 13:50:00 +01:00
board	doc: fix Arduino 101 documentation formatting issues	2016-05-20 16:18:38 +00:00
contribute	doc: collaboration: code: gerrit commit message JIRA key	2016-04-18 20:25:40 +00:00
crypto	docs: fixed crypto headline and bullet indentation	2016-02-25 21:28:58 +00:00
drivers	device: add macro to assign driver_api at compile time	2016-04-15 22:06:09 +00:00
getting_started	doc: Restructure top level sections.	2016-05-21 21:22:46 +00:00
kernel	kernel event logger: add possibility to use custom timestamp	2016-05-23 21:27:49 +00:00
porting	doc: Edit arch.rst markup	2016-05-03 13:09:16 -05:00
reference	doc: Restructure top level sections.	2016-05-21 21:22:46 +00:00
scripts/genrest	doc: use table for Kconfig option reference	2016-05-11 15:15:44 +00:00
subsystems	doc: fixed bullet list for bluetooth	2016-04-30 09:48:49 -04:00
themes/zephyr	…
Makefile	doc: show information about documentation current version	2016-04-22 10:54:38 +00:00
README.rst	doc: Change link in README to external link.	2016-02-08 16:16:59 -05:00
about_zephyr.rst	trivial: fixed typo: sempahores -> semaphores	2016-02-09 18:04:36 +00:00
conf.py	doc: sphinx conf: use env var in sphinx doc version	2016-04-13 23:42:18 +00:00
doxygen.config	kernel event logger: add possibility to use custom timestamp	2016-05-23 21:27:49 +00:00
index.rst	doc: Restructure top level sections.	2016-05-21 21:22:46 +00:00
substitutions.rst	…

README.rst

Welcome to Zephyr Kernel
########################

.. This document is in Restructured Text Format.
   Find more information regarding the ReST markup in the
   `ReST documentation`_.
   This is a comment that won't show up in formatted output

Welcome to the Zephyr Project.

Thank you for your interest in the Zephyr Project. These instructions are
designed to walk you through generating the Zephyr Project's documentation.

Documentation Notes
*******************

The project's documentation currently comprises the following items:

* An Installation Guide for Linux host systems

* A set of Collaboration Guidelines for the project.

* Doxygen output from the code base for all APIs.

Installing the documentation processors
***************************************

Install the current version of ``Sphinx``, type:

.. code-block:: bash

   $ git clone https://github.com/sphinx-doc/sphinx.git sphinx

   $ cd sphinx

   $ sudo -E python setup.py install

   $ cd ..

   $ git clone https://github.com/michaeljones/breathe.git breathe

   $ cd breathe

   $ sudo -E python setup.py install

.. note::

   Make sure that ``Doxygen`` is installed in your system.
   The installation of Doxygen is beyond the scope of this document.

Running the Documentation Generators
************************************

Assuming that the Zephyr Project tree with the doc directory is in
``DIRECTORY``, type:

.. code-block:: bash

   $ cd DIRECTORY/doc

   $ make doxy html

Find the output in ``DIRECTORY/doc/_build/html/index.html``

Review the available formats with:

.. code-block:: bash

   $ make -C DIRECTORY/doc doxy html

If you want the LaTeX PDF output, you need to install all the Latex
packages first. That installation is beyond the scope of this document.

.. _ReST documentation: http://sphinx-doc.org/rest.html