[PATCH compass-ci] define_files.md: text format adapt to markdown

In markdown documents, text for bash should be contained in block as belows: ```bash content ``` Signed-off-by: Xu Xijian <hdxuxijian@163.com> --- doc/job/define_files.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/job/define_files.md b/doc/job/define_files.md index 2c3457d..601d498 100644 --- a/doc/job/define_files.md +++ b/doc/job/define_files.md @@ -1,6 +1,7 @@ # define_files Meaning: +```bash - We use lkp-tests as client for compass-ci. There are many testcases in lkp-tests. most testcases contain the following files: distro/depends/$testcase distro/depends/$testcase-dev @@ -10,7 +11,10 @@ Meaning: jobs/$testcase.yaml - When user add new testcase files to lkp-tests or change existing testcase files in lkp-tests, these change files that related with test program would be added to define_files field. - The define_files field do not need to be specified by user in the $testcase.yaml. It can be generated automatically when user submit with the option '-a'. User can confirm the define_files field in the job.yaml under result_root. +``` Usage example: +```bash - % submit -a $testcase.yaml testbox=vm-2p8g--$USER os=openeuler os_arch=aarch64 os_version=20.03 - % cat /srv/result/$testcase/vm-2p8g--$USER/$date/$job_id/job.yaml +``` -- 2.23.0

On Tue, Dec 01, 2020 at 05:14:51PM +0800, Xu Xijian wrote:
In markdown documents, text for bash should be contained in block as belows: ```bash content ```
Signed-off-by: Xu Xijian <hdxuxijian@163.com> --- doc/job/define_files.md | 4 ++++ 1 file changed, 4 insertions(+)
diff --git a/doc/job/define_files.md b/doc/job/define_files.md index 2c3457d..601d498 100644 --- a/doc/job/define_files.md +++ b/doc/job/define_files.md @@ -1,6 +1,7 @@ # define_files
Meaning: +```bash - We use lkp-tests as client for compass-ci. There are many testcases in lkp-tests. most testcases contain the following files: distro/depends/$testcase distro/depends/$testcase-dev @@ -10,7 +11,10 @@ Meaning: jobs/$testcase.yaml - When user add new testcase files to lkp-tests or change existing testcase files in lkp-tests, these change files that related with test program would be added to define_files field. - The define_files field do not need to be specified by user in the $testcase.yaml. It can be generated automatically when user submit with the option '-a'. User can confirm the define_files field in the job.yaml under result_root. +```
I think these are the text and not for bash. Thanks, Xueliang
Usage example: +```bash - % submit -a $testcase.yaml testbox=vm-2p8g--$USER os=openeuler os_arch=aarch64 os_version=20.03 - % cat /srv/result/$testcase/vm-2p8g--$USER/$date/$job_id/job.yaml +``` -- 2.23.0

On Tue, Dec 01, 2020 at 11:23:02PM +0800, Cao Xueliang wrote:
On Tue, Dec 01, 2020 at 05:14:51PM +0800, Xu Xijian wrote:
In markdown documents, text for bash should be contained in block as belows: ```bash content ```
Signed-off-by: Xu Xijian <hdxuxijian@163.com> --- doc/job/define_files.md | 4 ++++ 1 file changed, 4 insertions(+)
diff --git a/doc/job/define_files.md b/doc/job/define_files.md index 2c3457d..601d498 100644 --- a/doc/job/define_files.md +++ b/doc/job/define_files.md @@ -1,6 +1,7 @@ # define_files
Meaning: +```bash - We use lkp-tests as client for compass-ci. There are many testcases in lkp-tests. most testcases contain the following files: distro/depends/$testcase distro/depends/$testcase-dev @@ -10,7 +11,10 @@ Meaning: jobs/$testcase.yaml - When user add new testcase files to lkp-tests or change existing testcase files in lkp-tests, these change files that related with test program would be added to define_files field. - The define_files field do not need to be specified by user in the $testcase.yaml. It can be generated automatically when user submit with the option '-a'. User can confirm the define_files field in the job.yaml under result_root. +```
I think these are the text and not for bash.
Thanks, Xueliang
It's "text for bash", in markdown documents, it will display strange if not specify, it's markdown's format. Thanks, Xijian

On Wed, Dec 02, 2020 at 09:22:36AM +0800, Xu Xijian wrote:
On Tue, Dec 01, 2020 at 11:23:02PM +0800, Cao Xueliang wrote:
On Tue, Dec 01, 2020 at 05:14:51PM +0800, Xu Xijian wrote:
In markdown documents, text for bash should be contained in block as belows: ```bash content ```
Signed-off-by: Xu Xijian <hdxuxijian@163.com> --- doc/job/define_files.md | 4 ++++ 1 file changed, 4 insertions(+)
diff --git a/doc/job/define_files.md b/doc/job/define_files.md index 2c3457d..601d498 100644 --- a/doc/job/define_files.md +++ b/doc/job/define_files.md @@ -1,6 +1,7 @@ # define_files
Meaning: +```bash - We use lkp-tests as client for compass-ci. There are many testcases in lkp-tests. most testcases contain the following files: distro/depends/$testcase distro/depends/$testcase-dev @@ -10,7 +11,10 @@ Meaning: jobs/$testcase.yaml - When user add new testcase files to lkp-tests or change existing testcase files in lkp-tests, these change files that related with test program would be added to define_files field. - The define_files field do not need to be specified by user in the $testcase.yaml. It can be generated automatically when user submit with the option '-a'. User can confirm the define_files field in the job.yaml under result_root. +```
I think these are the text and not for bash.
Thanks, Xueliang
It's "text for bash", in markdown documents, it will display strange if not specify, it's markdown's format.
Oh, I know that. Thanks, Xueliang
Thanks, Xijian
participants (2)
-
Cao Xueliang
-
Xu Xijian