misc: modify manual to build dockerfile #1783
Conversation
|
Please rewrite the commit message with complete sentences so that everyone who reads the message can understand why this change is needed. |
doc/uftrace.md
Outdated
| @@ -356,7 +356,7 @@ record and `replay` internally. Thus, it describes most regular option in detail | |||
| : Hide small functions run less than the *TIME* | |||
|
|
|||
| \--task | |||
| : [info]: Print task relationship in a tree form instead of the tracing info. | |||
| : [info] Print task relationship in a tree form instead of the tracing info. | |||
There was a problem hiding this comment.
I found that the same problem was there and the [info]: part was removed by 5c30743.
This is better to be removed.
| : [info] Print task relationship in a tree form instead of the tracing info. | |
| : Print task relationship in a tree form instead of the tracing info. |
|
And it's weird that two different commits have the same commit title. Please rewrite the commit message. |
haileynam
force-pushed
the
misc--modify-manual-to-build-Dockerfile
branch
2 times, most recently
from
4ebec8f
to
738ca1c
Compare
|
@honggyukim I have updated my commit and included your code review. Thank you for your comment. |
There was a problem hiding this comment.
Looks good. But the commit prefix should be "doc:" instead of "misc:". Also "Modify" has no value in the commit message and we want to know what or why. So the commit message line can be like below:
doc: Fix pandoc error in uftrace.md
Currently make install on some Ubuntu versions failed like below:
GEN uftrace.1
pandoc: blocks is null
CallStack (from HasCallStack):
error, called at src/Text/Pandoc/Writers/Man.hs:287:47 in pandoc-1.19.2.4-HbfKWUyODESBIy0vGktOwX:Text.Pandoc.Writers.Man
Makefile:18: recipe for target 'uftrace.1' failed
It's because the description of --task option has incompatible format in
the pandoc syntax. We don't need that part so let's get rid of it.
Fixed: #1766
95c8995
to
f9eab45
Compare
|
Hi @haileynam, the change looks good but I would like to ask you to change the commit title from to the one @namhyung suggested. I'm asking because any kind of commit does modify so |
Currently make install on some Ubuntu versions failed like below:
GEN uftrace.1
pandoc: blocks is null
CallStack (from HasCallStack):
error, called at src/Text/Pandoc/Writers/Man.hs:287:47 in pandoc-1.19.2.4-HbfKWUyODESBIy0vGktOwX:Text.Pandoc.Writers.Man
Makefile:18: recipe for target 'uftrace.1' failed
It's because the description of --task option has incompatible format in
the pandoc syntax. We don't need that part so let's get rid of it.
Fixed: namhyung#1766
Signed-off-by: Yoojung Nam <haileynam0408@gmail.com>
haileynam
force-pushed
the
misc--modify-manual-to-build-Dockerfile
branch
from
f9eab45
to
984281d
Compare
|
@honggyukim Sorry for my mistake. I just changed my commit including you and @namhyung suggested. Please check for it. |
Currently make install on some Ubuntu versions failed like below:
It's because the description of --task option has incompatible format in
the pandoc syntax. We don't need that part so let's get rid of it.
Fixed: #1766