[PATCH] doc: add new targets to "make help" output

[PATCH] doc: add new targets to "make help" output

[Gabriel Carrillo]

Commit aafaea3d3b70 ("devtools: add tags
and cscope index generation") introduced
new make targets. This change updates the
help target output to reflect the additions.

Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
---
 doc/build-sdk-quick.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
index 8d41052..0b8a309 100644
--- a/doc/build-sdk-quick.txt
+++ b/doc/build-sdk-quick.txt
@@ -11,6 +11,9 @@ Build commands
 	examples_clean   clean examples for given targets (T=)
 	test             compile tests and run basic unit tests
 	test-*           run specific subset of unit tests
+	tags T=          generate ctags for given targets (T=)
+	gtags T=         generate gtags for given targets (T=)
+	cscope T=        generate cscope database for given targets (T=)
 Build variables
 	EXTRA_CPPFLAGS   preprocessor options
 	EXTRA_CFLAGS     compiler options
-- 
2.6.4

Re: [PATCH] doc: add new targets to "make help" output

[Thomas Monjalon]

05/06/2017 23:43, Gabriel Carrillo:
> Commit aafaea3d3b70 ("devtools: add tags
> and cscope index generation") introduced
> new make targets. This change updates the
> help target output to reflect the additions.
> 
> Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
> ---
>  doc/build-sdk-quick.txt | 3 +++
>  1 file changed, 3 insertions(+)
> 
> --- a/doc/build-sdk-quick.txt
> +++ b/doc/build-sdk-quick.txt
> @@ -11,6 +11,9 @@ Build commands
>  	examples_clean   clean examples for given targets (T=)
>  	test             compile tests and run basic unit tests
>  	test-*           run specific subset of unit tests
> +	tags T=          generate ctags for given targets (T=)
> +	gtags T=         generate gtags for given targets (T=)
> +	cscope T=        generate cscope database for given targets (T=)

It should be a quick help.
Either we put tags/cscope on one line or we put nothing at all.

[PATCH v2] doc: add new targets to "make help" output

[Gabriel Carrillo]

Commit aafaea3d3b70 ("devtools: add tags
and cscope index generation") introduced
new make targets. This change updates the
help target output to reflect the additions.

Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
---
 doc/build-sdk-quick.txt | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
index 8d41052..8ed9d80 100644
--- a/doc/build-sdk-quick.txt
+++ b/doc/build-sdk-quick.txt
@@ -1,16 +1,17 @@
 Basic build
 	make config T=x86_64-native-linuxapp-gcc && make
 Build commands
-	config           get configuration from target template (T=)
-	all              same as build (default rule)
-	build            build in a configured directory
-	clean            remove files but keep configuration
-	install T=       configure, build and install a target in DESTDIR
-	install          install optionally staged in DESTDIR
-	examples         build examples for given targets (T=)
-	examples_clean   clean examples for given targets (T=)
-	test             compile tests and run basic unit tests
-	test-*           run specific subset of unit tests
+	config			get configuration from target template (T=)
+	all			same as build (default rule)
+	build			build in a configured directory
+	clean			remove files but keep configuration
+	install T=		configure, build and install a target in DESTDIR
+	install			install optionally staged in DESTDIR
+	examples   		build examples for given targets (T=)
+	examples_clean		clean examples for given targets (T=)
+	test                  	compile tests and run basic unit tests
+	test-*               	run specific subset of unit tests
+	tags|gtags|cscope [T=]  generate tags or cscope index
 Build variables
 	EXTRA_CPPFLAGS   preprocessor options
 	EXTRA_CFLAGS     compiler options
-- 
2.6.4

Re: [PATCH v2] doc: add new targets to "make help" output

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Gabriel Carrillo
> Sent: Tuesday, June 6, 2017 5:43 PM
> To: thomas@monjalon.net
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2] doc: add new targets to "make help" output
> 
> Commit aafaea3d3b70 ("devtools: add tags and cscope index generation")
> introduced new make targets. This change updates the help target output to
> reflect the additions.
> 
> Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
> ---
>  doc/build-sdk-quick.txt | 21 +++++++++++----------
>  1 file changed, 11 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt index
> 8d41052..8ed9d80 100644
> --- a/doc/build-sdk-quick.txt
> +++ b/doc/build-sdk-quick.txt
> @@ -1,16 +1,17 @@
>  Basic build
>  	make config T=x86_64-native-linuxapp-gcc && make  Build commands
> -	config           get configuration from target template (T=)
> -	all              same as build (default rule)
> -	build            build in a configured directory
> -	clean            remove files but keep configuration
> -	install T=       configure, build and install a target in DESTDIR
> -	install          install optionally staged in DESTDIR
> -	examples         build examples for given targets (T=)
> -	examples_clean   clean examples for given targets (T=)
> -	test             compile tests and run basic unit tests
> -	test-*           run specific subset of unit tests
> +	config			get configuration from target template (T=)
> +	all			same as build (default rule)
> +	build			build in a configured directory
> +	clean			remove files but keep configuration
> +	install T=		configure, build and install a target in DESTDIR
> +	install			install optionally staged in DESTDIR
> +	examples   		build examples for given targets (T=)
> +	examples_clean		clean examples for given targets (T=)
> +	test                  	compile tests and run basic unit tests
> +	test-*               	run specific subset of unit tests
> +	tags|gtags|cscope [T=]  generate tags or cscope index
>  Build variables
>  	EXTRA_CPPFLAGS   preprocessor options
>  	EXTRA_CFLAGS     compiler options
> --

Hi,

Thanks for this. Unfortunately there is a mix of tabs and spaces used
for the alignment so the output cat look funny depending on tab
settings.

I know that Thomas commented that the previous version was too verbose
but it looked better to me. Maybe we could compromise on:

	tags|gtags T=    generate tags/gtags for given targets (T=)
	cscope T=        generate cscope database for given targets (T=)

John

Re: [PATCH v2] doc: add new targets to "make help" output

[Carrillo, Erik G]

Response in-line:

> -----Original Message-----
> From: Mcnamara, John
> Sent: Monday, June 26, 2017 10:38 AM
> To: Carrillo, Erik G <erik.g.carrillo@intel.com>; thomas@monjalon.net
> Cc: dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v2] doc: add new targets to "make help"
> output
> 
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Gabriel Carrillo
> > Sent: Tuesday, June 6, 2017 5:43 PM
> > To: thomas@monjalon.net
> > Cc: dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH v2] doc: add new targets to "make help"
> > output
> >
> > Commit aafaea3d3b70 ("devtools: add tags and cscope index generation")
> > introduced new make targets. This change updates the help target
> > output to reflect the additions.
> >
> > Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
> > ---
> >  doc/build-sdk-quick.txt | 21 +++++++++++----------
> >  1 file changed, 11 insertions(+), 10 deletions(-)
> >
> > diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt index
> > 8d41052..8ed9d80 100644
> > --- a/doc/build-sdk-quick.txt
> > +++ b/doc/build-sdk-quick.txt
> > @@ -1,16 +1,17 @@
> >  Basic build
> >  	make config T=x86_64-native-linuxapp-gcc && make  Build
> commands
> > -	config           get configuration from target template (T=)
> > -	all              same as build (default rule)
> > -	build            build in a configured directory
> > -	clean            remove files but keep configuration
> > -	install T=       configure, build and install a target in DESTDIR
> > -	install          install optionally staged in DESTDIR
> > -	examples         build examples for given targets (T=)
> > -	examples_clean   clean examples for given targets (T=)
> > -	test             compile tests and run basic unit tests
> > -	test-*           run specific subset of unit tests
> > +	config			get configuration from target template (T=)
> > +	all			same as build (default rule)
> > +	build			build in a configured directory
> > +	clean			remove files but keep configuration
> > +	install T=		configure, build and install a target in DESTDIR
> > +	install			install optionally staged in DESTDIR
> > +	examples   		build examples for given targets (T=)
> > +	examples_clean		clean examples for given targets (T=)
> > +	test                  	compile tests and run basic unit tests
> > +	test-*               	run specific subset of unit tests
> > +	tags|gtags|cscope [T=]  generate tags or cscope index
> >  Build variables
> >  	EXTRA_CPPFLAGS   preprocessor options
> >  	EXTRA_CFLAGS     compiler options
> > --
> 
> Hi,
> 
> Thanks for this. Unfortunately there is a mix of tabs and spaces used for the
> alignment so the output cat look funny depending on tab settings.
> 
> I know that Thomas commented that the previous version was too verbose
> but it looked better to me. Maybe we could compromise on:
> 
> 	tags|gtags T=    generate tags/gtags for given targets (T=)
> 	cscope T=        generate cscope database for given targets (T=)
> 
> John
> 

Thanks for the feedback, John.  I'll submit an updated patch.

Regards,
Gabriel

[PATCH v3] doc: add new targets to "make help" output

[Gabriel Carrillo]

Commit aafaea3d3b70 ("devtools: add tags
and cscope index generation") introduced
new make targets. This change updates the
help target output to reflect the additions.

Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
---
v3:
* Updated formatting.

 doc/build-sdk-quick.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt
index 8d41052..3507220 100644
--- a/doc/build-sdk-quick.txt
+++ b/doc/build-sdk-quick.txt
@@ -11,6 +11,8 @@ Build commands
 	examples_clean   clean examples for given targets (T=)
 	test             compile tests and run basic unit tests
 	test-*           run specific subset of unit tests
+	tags|gtags T=    generate tags/gtags for given targets (T=)
+	cscope T=        generate cscope database for given targets (T=)
 Build variables
 	EXTRA_CPPFLAGS   preprocessor options
 	EXTRA_CFLAGS     compiler options
-- 
2.6.4

Re: [PATCH v3] doc: add new targets to "make help" output

[Thomas Monjalon]

Hi,

Sorry for the very very late review.

07/07/2017 19:09, Gabriel Carrillo:
> Commit aafaea3d3b70 ("devtools: add tags
> and cscope index generation") introduced
> new make targets. This change updates the
> help target output to reflect the additions.
> 
> Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
> ---
> +	tags|gtags T=    generate tags/gtags for given targets (T=)
> +	cscope T=        generate cscope database for given targets (T=)

No need of T= in the first column.
It is specified only for install which has two different meanings
with and without T=.

You should also add etags I think.

Re: [PATCH v3] doc: add new targets to "make help" output

[Thomas Monjalon]

04/08/2017 00:50, Thomas Monjalon:
> Hi,
> 
> Sorry for the very very late review.
> 
> 07/07/2017 19:09, Gabriel Carrillo:
> > Commit aafaea3d3b70 ("devtools: add tags
> > and cscope index generation") introduced
> > new make targets. This change updates the
> > help target output to reflect the additions.
> > 
> > Signed-off-by: Gabriel Carrillo <erik.g.carrillo@intel.com>
> > ---
> > +	tags|gtags T=    generate tags/gtags for given targets (T=)
> > +	cscope T=        generate cscope database for given targets (T=)
> 
> No need of T= in the first column.
> It is specified only for install which has two different meanings
> with and without T=.
> 
> You should also add etags I think.

Updated myself and applied, thanks