[ktap] Re: [PATCH] doc: document libelf dependency
- From: Jovi Zhangwei <jovi.zhangwei@xxxxxxxxx>
- To: ktap <ktap@xxxxxxxxxxxxx>
- Date: Mon, 11 Nov 2013 10:34:21 +0800
On Mon, Nov 11, 2013 at 1:39 AM, Azat Khuzhin <a3at.mail@xxxxxxxxx> wrote:
> Hi Ben,
>
> On Sun, Nov 10, 2013 at 9:25 PM, Ben Noordhuis <info@xxxxxxxxxxxxx> wrote:
>> Signed-off-by: Ben Noordhuis <info@xxxxxxxxxxxxx>
>> ---
>> README.md | 6 ++++++
>> 1 file changed, 6 insertions(+)
>>
>> diff --git a/README.md b/README.md
>> index a438356..7bc57ef 100644
>> --- a/README.md
>> +++ b/README.md
>> @@ -29,6 +29,12 @@ More information can be found at [ktap
>> homepage][homepage].
>> * supported in x86, arm, ppc, mips
>> * safety in sandbox
>>
>> +## Requirements
>> +
>> + * libelf (optional). Install elfutils-libelf-devel on RHEL-based distros,
>> + libelf-dev on Debian-based distros. Use `make NO_LIBELF=1` to build
>> + without libelf support.
>> +
>
> I think here we need to describe the reason for users,
> to let them decide, whether they need install it.
>
> Simple description:
> libelf is required for resolving symbols to addresses in DSO,
> and for stapsdt. (in future)
>
Looks like a good idea.
Ben, can you also update the "Requirements" section in doc/tutorial.md?
and "Requirements" section would be same in README.md and doc/tutorial.md.
Thank you very much.
Jovi
Other related posts:
