xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 17:23:08 +00:00
Code Issues Releases Wiki Activity

Remove trailing spaces in file docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst

Browse Source
This commit is contained in:
GONG Jie 2017-12-31 23:59:59 +00:00
parent 16a0c18706
commit 44a6f09a29
1 changed files with 54 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst
View File

@ -30,15 +30,15 @@ DESCRIPTION
xCAT offers two trace facilities to debug the xCAT:
\ **Subroutine calling trace**\
\ **Subroutine calling trace**\
Display the calling trace for subroutine when it is called.
The trace message includes: The name of the called subroutine; The arguments which passed to the called subroutine; The calling stack of the subroutine. By default, the trace will be enabled to all the subroutines in the xcatd and plugin modules. The target subroutine can be configured by configuration file or through xcatdebug command line.
The flag \ **-c**\ is used to specify the subroutine list for \ **subroutine calling trace**\ , it can only work with \ **-f**\ . The value of \ **-c**\ can be a configuration file or a subroutine list.
\ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\
\ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
\ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\
\ **subroutine list**\ : \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
\ **SUBROUTINE_DEFINITION**\ : is the element for the \ **-c**\ to specify the subroutine list.
@ -53,7 +53,7 @@ Otherwise, the package name of the plugin should be specified.
The trace log will be written to /var/log/xcat/subcallingtrace. The log file subcallingtrace will be backed up for each running of the \ **xcatdebug -f enable**\ .
\ **Commented trace log**\
\ **Commented trace log**\
The trace log code is presented as comments in the code of xCAT. In general mode, it will be kept as comments. But in debug mode, it will be commented back as common code to display the trace log.
@ -88,39 +88,39 @@ OPTIONS
\ **-f**\
\ **-f**\
Enable or disable the \ **subroutine calling trace**\ .
For \ **enable**\ , if ignoring the \ **-c**\ flag, all the subroutines in the xcatd and plugin modules will be enabled.
For \ **disable**\ , all the subroutines which has been enabled by \ **-f enable**\ will be disabled. \ **-c**\ will be ignored.
\ **-c**\
\ **-c**\
Specify the configuration file or subroutine list.
\ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\
\ **configuration file**\ : a file contains multiple lines of \ **SUBROUTINE_DEFINITION**\
e.g.
(plugin_command)
xCAT_plugin::DBobjectdefs(defls,process_request)
xCAT::DBobjUtils(getobjdefs)
\ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
\ **subroutine list**\ : a string like \ **SUBROUTINE_DEFINITION | SUBROUTINE_DEFINITION|...**\
e.g.
"(plugin_command)|xCAT_plugin::DBobjectdefs(defls,process_request)|xCAT::DBobjUtils(getobjdefs)"
\ **-d**\
\ **-d**\
Enable or disable the \ **commented trace log**\ .
Note: The xcatd will be restarted for the performing of \ **-d**\
Note: The xcatd will be restarted for the performing of \ **-d**\
@ -131,62 +131,62 @@ EXAMPLES
1. Enable the \ **subroutine calling trace**\ for all the subroutines in the xcatd and plugin modules.
.. code-block:: perl
xcatdebug -f enable
2. Enable the \ **subroutine calling trace**\ for the subroutines configured in the /opt/xcat/share/xcat/samples/tracelevel0
.. code-block:: perl
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0
3. Enable the \ **subroutine calling trace**\ for the plugin_command in xcatd and defls,process_request in the xCAT_plugin::DBobjectdefs module.
.. code-block:: perl
xcatdebug -f enable -c "xCAT_plugin::DBobjectdefs(defls,process_request)|(plugin_command)"
4. Disable the \ **subroutine calling trace**\ for all the subroutines which have been enabled by \ **xcatdebug -f enable**\ .
.. code-block:: perl
xcatdebug -f disable
5. Enable the \ **commented trace log**\
5. Enable the \ **commented trace log**\
.. code-block:: perl
xcatdebug -d enable
6. Enable both the \ **subroutine calling trace**\ and \ **commented trace log**\
6. Enable both the \ **subroutine calling trace**\ and \ **commented trace log**\
.. code-block:: perl
xcatdebug -f enable -c /opt/xcat/share/xcat/samples/tracelevel0 -d enable