From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: John McNamara <john.mcnamara@intel.com>, dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v2] doc: automate examples file list for API doc
Date: Wed, 8 Feb 2017 17:35:51 +0000 [thread overview]
Message-ID: <9af1a152-11dc-55e0-b9f4-5e6f54bd3675@intel.com> (raw)
In-Reply-To: <1665905.OHHQAK7vyE@xps13>
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.yigit@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.
>
next prev parent reply other threads:[~2017-02-08 17:35 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-27 11:55 [dpdk-dev] [PATCH] doc: update examples list for API Ferruh Yigit
2017-01-27 13:11 ` De Lara Guarch, Pablo
2017-01-27 15:56 ` Thomas Monjalon
2017-01-27 17:03 ` Ferruh Yigit
2017-01-27 17:37 ` [dpdk-dev] [PATCH v2] doc: automate examples file list for API doc Ferruh Yigit
2017-02-08 12:08 ` Thomas Monjalon
2017-02-08 17:35 ` Ferruh Yigit [this message]
2017-02-08 17:54 ` [dpdk-dev] [PATCH v3] " Ferruh Yigit
2017-02-08 18:12 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9af1a152-11dc-55e0-b9f4-5e6f54bd3675@intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=thomas.monjalon@6wind.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).