On 2/8/2017 12:08 PM, Thomas Monjalon wrote:
> 2017-01-27 17:37, Ferruh Yigit:
>> These files are linked to API documentation as usage samples, list of
>> files created automatically during doc creation.
>>
>> Remove manually updated old one.
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yi...@intel.com>
> [...]
>> +API_EXAMPLES := $(RTE_OUTPUT)/doc/html/examples.dox
>
> I feel it should be in $(RTE_OUTPUT)/doc/ because the doc could be generated
> in another format (not HTML only).
Not sure, the rules use this file creates hardcoded
$(RTE_OUTPUT)/doc/html/ folder. Right now only user of this file is html
api document.
Putting this file to the root build/doc folder will work as fine, but I
think that file will look ugly there.
>
> [...]
>
>> @echo 'doxygen for API...'
>> $(Q)mkdir -p $(RTE_OUTPUT)/doc/html
>> $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf && \
>> + echo INPUT += $(API_EXAMPLES) && \
>> printf 'PROJECT_NUMBER = ' && \
>> $(MAKE) -rR showversion && \
>
> It would be nicer to see INPUT here.
OK
>
>> echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \
>
> [...]
>
>> +$(API_EXAMPLES):
>> + $(Q)mkdir -p $(RTE_OUTPUT)/doc/html
>> + @echo "/**" > $(API_EXAMPLES)
>> + @echo "@page examples DPDK Example Programs" >> $(API_EXAMPLES)
>> + @echo "" >> $(API_EXAMPLES)
>> + @find examples -type f -name "*.c" | awk '{ print "@example", $$0 }' >>
>> $(API_EXAMPLES)
>
> May I suggest this simpler syntax?
> find examples -type f -name '*.c' -printf '@example %p\n'
Looks better, thanks.
I will send a new version soon.
>
> Please prefer simple quotes where possible.
>
