bpftool doc man page build failure

bpftool doc man page build failure

[Yonghong Song]

Quentin,

I hit the following errors with latest bpf-next.

-bash-4.4$ make man
   GEN      bpftool-perf.8
   GEN      bpftool-map.8
   GEN      bpftool.8
   GEN      bpftool-net.8
   GEN      bpftool-feature.8
   GEN      bpftool-prog.8
   GEN      bpftool-cgroup.8
   GEN      bpftool-btf.8
   GEN      bpf-helpers.rst
Parsed description of 111 helper function(s)
Traceback (most recent call last):
   File "../../../../scripts/bpf_helpers_doc.py", line 421, in <module>
     printer.print_all()
   File "../../../../scripts/bpf_helpers_doc.py", line 187, in print_all
     self.print_one(helper)
   File "../../../../scripts/bpf_helpers_doc.py", line 378, in print_one
     self.print_proto(helper)
   File "../../../../scripts/bpf_helpers_doc.py", line 356, in print_proto
     proto = helper.proto_break_down()
   File "../../../../scripts/bpf_helpers_doc.py", line 56, in 
proto_break_down
     'type' : capture.group(1),
AttributeError: 'NoneType' object has no attribute 'group'
make: *** [bpf-helpers.rst] Error 1
-bash-4.4$ pwd
/home/yhs/work/net-next/tools/bpf/bpftool/Documentation
-bash-4.4$

Maybe a format issue in the comments with some recent helpers?

Thanks,

Yonghong

Re: bpftool doc man page build failure

[Quentin Monnet]

2019-05-03 16:21 UTC+0000 ~ Yonghong Song <yhs@fb.com>
> Quentin,
> 
> I hit the following errors with latest bpf-next.
> 
> -bash-4.4$ make man
>    GEN      bpftool-perf.8
>    GEN      bpftool-map.8
>    GEN      bpftool.8
>    GEN      bpftool-net.8
>    GEN      bpftool-feature.8
>    GEN      bpftool-prog.8
>    GEN      bpftool-cgroup.8
>    GEN      bpftool-btf.8
>    GEN      bpf-helpers.rst
> Parsed description of 111 helper function(s)
> Traceback (most recent call last):
>    File "../../../../scripts/bpf_helpers_doc.py", line 421, in <module>
>      printer.print_all()
>    File "../../../../scripts/bpf_helpers_doc.py", line 187, in print_all
>      self.print_one(helper)
>    File "../../../../scripts/bpf_helpers_doc.py", line 378, in print_one
>      self.print_proto(helper)
>    File "../../../../scripts/bpf_helpers_doc.py", line 356, in print_proto
>      proto = helper.proto_break_down()
>    File "../../../../scripts/bpf_helpers_doc.py", line 56, in 
> proto_break_down
>      'type' : capture.group(1),
> AttributeError: 'NoneType' object has no attribute 'group'
> make: *** [bpf-helpers.rst] Error 1
> -bash-4.4$ pwd
> /home/yhs/work/net-next/tools/bpf/bpftool/Documentation
> -bash-4.4$
> 
> Maybe a format issue in the comments with some recent helpers?
> 
> Thanks,
> 
> Yonghong
> 

Hi Yonghong,

Thanks for the notice! Yes, I observed the same thing not long ago. It
seems that the Python script breaks on the "unsigned long" pointer
argument for strtoul(): the script only accepts "const" or "struct" for
types made of several words, not "unsigned".

I'll fix the script so it can take any word and send a patch next week,
along with some other clean-up fixes for the doc.

Best regards,
Quentin

Re: bpftool doc man page build failure

[Yonghong Song]

On 5/3/19 9:54 AM, Quentin Monnet wrote:
> 2019-05-03 16:21 UTC+0000 ~ Yonghong Song <yhs@fb.com>
>> Quentin,
>>
>> I hit the following errors with latest bpf-next.
>>
>> -bash-4.4$ make man
>>     GEN      bpftool-perf.8
>>     GEN      bpftool-map.8
>>     GEN      bpftool.8
>>     GEN      bpftool-net.8
>>     GEN      bpftool-feature.8
>>     GEN      bpftool-prog.8
>>     GEN      bpftool-cgroup.8
>>     GEN      bpftool-btf.8
>>     GEN      bpf-helpers.rst
>> Parsed description of 111 helper function(s)
>> Traceback (most recent call last):
>>     File "../../../../scripts/bpf_helpers_doc.py", line 421, in <module>
>>       printer.print_all()
>>     File "../../../../scripts/bpf_helpers_doc.py", line 187, in print_all
>>       self.print_one(helper)
>>     File "../../../../scripts/bpf_helpers_doc.py", line 378, in print_one
>>       self.print_proto(helper)
>>     File "../../../../scripts/bpf_helpers_doc.py", line 356, in print_proto
>>       proto = helper.proto_break_down()
>>     File "../../../../scripts/bpf_helpers_doc.py", line 56, in
>> proto_break_down
>>       'type' : capture.group(1),
>> AttributeError: 'NoneType' object has no attribute 'group'
>> make: *** [bpf-helpers.rst] Error 1
>> -bash-4.4$ pwd
>> /home/yhs/work/net-next/tools/bpf/bpftool/Documentation
>> -bash-4.4$
>>
>> Maybe a format issue in the comments with some recent helpers?
>>
>> Thanks,
>>
>> Yonghong
>>
> 
> Hi Yonghong,
> 
> Thanks for the notice! Yes, I observed the same thing not long ago. It
> seems that the Python script breaks on the "unsigned long" pointer
> argument for strtoul(): the script only accepts "const" or "struct" for
> types made of several words, not "unsigned".
> 
> I'll fix the script so it can take any word and send a patch next week,
> along with some other clean-up fixes for the doc.

Thanks!

> 
> Best regards,
> Quentin
>