<docs> update en doc
This commit is contained in:
9
docs/src/log/contents.rst
Normal file
9
docs/src/log/contents.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
.. _log:
|
||||
|
||||
Running log
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
|
||||
log_file
|
||||
log_verbose
|
||||
28
docs/src/log/log_file.rst
Normal file
28
docs/src/log/log_file.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
.. _log_file:
|
||||
|
||||
Enable log file
|
||||
================
|
||||
|
||||
.. tip::
|
||||
|
||||
If import glog to build.
|
||||
|
||||
The general configuration of the log in the head file `logger.h <https://github.com/slightech/MYNT-EYE-S-SDK/blob/master/include/mynteye/logger.h>`_ .
|
||||
|
||||
Uncomment ``FLAGS_log_dir = \".\";`` recompile and save to current work directory. Run ``camera_a`` log file as follows:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
<workdir>/
|
||||
├─camera_a.ERROR
|
||||
├─camera_a.FATAL
|
||||
├─camera_a.INFO
|
||||
├─camera_a.WARNING
|
||||
├─camera_a.john-ubuntu.john.log.ERROR.20180513-141833.519
|
||||
├─camera_a.john-ubuntu.john.log.FATAL.20180513-141833.519
|
||||
├─camera_a.john-ubuntu.john.log.INFO.20180513-141832.519
|
||||
└─camera_a.john-ubuntu.john.log.WARNING.20180513-141833.519
|
||||
|
||||
``camera_a.INFO`` shows the program and levers of log it is running. The link to the real log file is ``camera_a.john-ubuntu.john.log.INFO.20180513-141832.519``. Even if it ran several times, ``camera_a.INFO`` still leaves the link to last log file.
|
||||
|
||||
Excute `make cleanlog` to clean all log files.
|
||||
18
docs/src/log/log_verbose.rst
Normal file
18
docs/src/log/log_verbose.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
.. _log_verbose:
|
||||
|
||||
Enabled detailed level
|
||||
=======================
|
||||
|
||||
.. tip::
|
||||
|
||||
If import glog to build.
|
||||
|
||||
The general configuration of the log is in the head file `logger.h <https://github.com/slightech/MYNT-EYE-S-SDK/blob/master/include/mynteye/logger.h>`_ .
|
||||
|
||||
Uncomment ``FLAGS_v = 2`` ; and recompile to enable the detail levels, the log is printed by ``VLOG(n)``
|
||||
|
||||
For information on how to use the log library, such as how to configure, print, etc., please open its document and learn more:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ ./scripts/open.sh third_party/glog/doc/glog.html
|
||||
Reference in New Issue
Block a user