xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-13 09:50:19 +00:00
Code Issues Releases Wiki Activity

update docoment and man page

Browse Source
This commit is contained in:
caomengmeng
2016-10-31 23:30:33 -04:00
parent 97f6fc8083
commit c3dfe43b72
2 changed files with 45 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/source/guides/admin-guides/references/man1/xcattest.1.rst
View File

@ -21,11 +21,21 @@ SYNOPSIS
\ **xcattest**\ [\ **-?|-h**\ ]
\ **xcattest**\ [\ **-f**\ \ *configure file*\ ] [\ **-b**\ \ *case bundle list*\ ] [\ **-l**\ ]
\ **xcattest**\ [\ **-f**\ \ *configure file*\ ] [\ **-b**\ \ *case bundle list*\ ]
\ **xcattest**\ [\ **-f**\ \ *configure file*\ ] [\ **-t**\ \ *case list*\ ]
\ **xcattest**\ [\ **-f**\ \ *configure file*\ ] [\ **-c**\ \ *cmd list*\ ] [\ **-l**\ ]
\ **xcattest**\ [\ **-f**\ \ *configure file*\ ] [\ **-c**\ \ *cmd list*\ ]
\ **xcattest**\ [\ **-b**\ \ *case bundle list*\ ] [\ **-l**\ ]
\ **xcattest**\ [\ **-t**\ \ *case list*\ ] [\ **-l**\ ]
\ **xcattest**\ [\ **-c**\ \ *cmd list*\ ] [\ **-l**\ ]
\ **xcattest**\ [\ **-s**\ \ *command*\ ]
\ **xcattest**\ [\ **-s**\ \ *bundle*\ ]
***********
@ -52,7 +62,7 @@ OPTIONS
\ **-f**\ \ *configure file*\
Specifies the configuration file, if not specified, the default configure file is /opt/xcat/share/xcat/tools/autotest/default.conf.
Specifies the configuration file with full-path. xCAT supports an example config file: /opt/xcat/share/xcat/tools/autotest/linux.conf.template
@ -79,7 +89,9 @@ OPTIONS
Display the test cases names specified by the flag -b, -t or -c.
\ **-s**\
Display the bundle files and command with value: bundle or command.
************
RETURN VALUE
@ -136,33 +148,33 @@ EXAMPLES
.. code-block:: perl
xcattest -c /tmp/config -c rpower
xcattest -f /tmp/config -c rpower
2.
To run customized bundle:
To run customized bundle with /tmp/config file:
.. code-block:: perl
xcattest -l > /tmp/custom.bundle
xcattest -l > /opt/xcat/share/xcat/tools/autotest/bundle/custom.bundle
Modify custom.bundle
xcattest -b custom.bundle
xcattest -f /tmp/config -b custom.bundle
3.
To run specified test cases.
To run specified test cases with /tmp/config:
.. code-block:: perl
xcattest -t lsdef_t_o_l_z
xcattest -f /tmp/config -t lsdef_t_o_l_z

34
xCAT-test/pods/man1/xcattest.1.pod
View File

@ -6,11 +6,21 @@ B<xcattest> - Run automated xCAT test cases.
B<xcattest> [B<-?|-h>]
B<xcattest> [B<-f> I<configure file>] [B<-b> I<case bundle list>] [B<-l>]
B<xcattest> [B<-f> I<configure file>] [B<-b> I<case bundle list>]
B<xcattest> [B<-f> I<configure file>] [B<-t> I<case list>]
B<xcattest> [B<-f> I<configure file>] [B<-c> I<cmd list>] [B<-l>]
B<xcattest> [B<-f> I<configure file>] [B<-c> I<cmd list>]
B<xcattest> [B<-b> I<case bundle list>] [B<-l>]
B<xcattest> [B<-t> I<case list>] [B<-l>]
B<xcattest> [B<-c> I<cmd list>] [B<-l>]
B<xcattest> [B<-s> B<command>]
B<xcattest> [B<-s> B<bundle>]
=head1 DESCRIPTION
@ -28,11 +38,11 @@ Display usage message.
=item B<-f> I<configure file>
Specifies the configuration file, if not specified, the default configure file is /opt/xcat/share/xcat/tools/autotest/default.conf.
Specifies the configuration file with full-path. xCAT supports an example config file: /opt/xcat/share/xcat/tools/autotest/linux.conf.template
=item B<-b> I<case bundle list>
Comma separated list of test cases bundle files, each test cases bundle can contain multiple lines and each line for one test case name.
Comma separated list of test cases bundle files, each test cases bundle can contain multiple lines and each line for one test case name. The bundle files should be listed in: /opt/xcat/share/xcat/tools/autotest/bundle.
=item B<-t> I<cases list>
@ -46,6 +56,10 @@ Comma separated list of commands which will be tested, i.e., all the test cases
Display the test cases names specified by the flag -b, -t or -c.
=item B<-s>
Display the bundle files and command with value: bundle or command.
=back
=head1 RETURN VALUE
@ -86,21 +100,21 @@ B<Note>: Each test case can have more than one I<cmd> sections and each I<cmd> s
To run all test cases related command rpower:
xcattest -c /tmp/config -c rpower
xcattest -f /tmp/config -c rpower
=item 2.
To run customized bundle:
To run customized bundle with /tmp/config file:
xcattest -l > /tmp/custom.bundle
xcattest -c lsdef -l > /opt/xcat/share/xcat/tools/autotest/bundle/custom.bundle
Modify custom.bundle
xcattest -b custom.bundle
xcattest -f /tmp/config -b custom.bundle
=item 3.
To run specified test cases.
To run specified test cases with /tmp/config file:
xcattest -t lsdef_t_o_l_z
xcattest -f /tmp/config -t lsdef_t_o_l_z
=item 4.