On Wed, Dec 16, 2020 at 11:44:57AM +0800, Xu Xijian wrote:

In markdown documents, text for bash should be contained in block as belows:

content
SHELL

There are 2 ways style code with markdown:

1. indent with four spaces (basic):

if (isAwesome){ return true }

2. code fencing (GFM):

```javascript if (isAwesome){ return true } ```

Thanks, RenWen

Signed-off-by: Xu Xijian hdxuxijian@163.com

doc/code-spec.md | 2 ++ 1 file changed, 2 insertions(+)

diff --git a/doc/code-spec.md b/doc/code-spec.md index d44c6fe..a717f64 100644 --- a/doc/code-spec.md +++ b/doc/code-spec.md @@ -21,10 +21,12 @@ code注意事项

• puts/printf字符串应当容易搜索(grep)。特别注意包含足够长的固定内容substring.

例如： +```SHELL die "test yaml(${test_yaml}) not exist in ${LKP_SRC}/jobs !!!" ==> die "cannot find test yaml ($test_yaml) in $LKP_SRC/jobs" ^^^^^^^^^^^^^^^^^^^^^ grep-friendly fixed substring +```

重构友好编码

-- 2.23.0