diff mbox

[1/2] configure.ac: improve help text

Message ID 1420742059-7699-1-git-send-email-mike.holmes@linaro.org
State Superseded
Headers show

Commit Message

Mike Holmes Jan. 8, 2015, 6:34 p.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 configure.ac | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

Ciprian Barbu Jan. 9, 2015, 2:15 p.m. UTC | #1
On Thu, Jan 8, 2015 at 8:34 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>  configure.ac | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/configure.ac b/configure.ac
> index f0ce7e0..440cc63 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -44,16 +44,16 @@ AC_TYPE_UINT64_T
>  # Determine which platform to build for
>  ##########################################################################
>  AC_ARG_WITH([platform],
> -    [AS_HELP_STRING([--with-platform=prefix],
> -        [Select platform to be used, default linux-generic])],
> +    [AS_HELP_STRING([--with-platform=platform],
> +        [select platform to be used, default linux-generic])],
>      [],
>      [with_platform=linux-generic])
>
>  AC_SUBST([with_platform])
>
>  AC_ARG_WITH([sdk-install-path],
> -AC_HELP_STRING([--with-sdk-install-path=DIR Path to external libs and headers],
> -               [(or in the default path if not specified).]),
> +AC_HELP_STRING([--with-sdk-install-path=DIR path to external libs and headers],
> +             [(or in the default path if not specified).]),
>  [SDK_INSTALL_PATH=$withval SDK_INSTALL_PATH_=1],[SDK_INSTALL_PATH_=])
>
>  AC_SUBST(SDK_INSTALL_PATH)
> @@ -86,7 +86,7 @@ AC_HELP_STRING([--with-cunit-path=DIR Path to Cunit libs and headers],
>  ##########################################################################
>  ODP_DEBUG_PRINT=1
>  AC_ARG_ENABLE([debug-print],
> -    [  --enable-debug-print         Enable/disable debug print],
> +    [  --enable-debug-print    display debugging information],
>      [if ! test "x$enableval" = "xyes"; then
>          ODP_DEBUG_PRINT=0
>      fi])
> @@ -97,7 +97,7 @@ ODP_CFLAGS="$ODP_CFLAGS -DODP_DEBUG_PRINT=$ODP_DEBUG_PRINT"
>  ##########################################################################
>  ODP_DEBUG=1
>  AC_ARG_ENABLE([debug],
> -    [  --enable-debug         Enable/disable debug],
> +    [  --enable-debug          include additional code],

This is only used by ODP_ASSERT, is that what 'additional code' means?

>      [if ! test "x$enableval" = "xyes"; then
>          ODP_DEBUG=0
>      fi])
> @@ -129,7 +129,7 @@ AM_CONDITIONAL([HAVE_DOXYGEN], [test "x${DOXYGEN}" = "xdoxygen"])
>  # Set optional OpenSSL path
>  ##########################################################################
>  AC_ARG_WITH([openssl-path],
> -AC_HELP_STRING([--with-openssl-path=DIR Path to openssl libs and headers],
> +AC_HELP_STRING([--with-openssl-path=DIR path to openssl libs and headers],
>                 [(or in the default path if not specified).]),
>      [OPENSSL_PATH=$withval
>      AM_CPPFLAGS="$AM_CPPFLAGS -I$OPENSSL_PATH/include"
> --
> 2.1.0
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
Mike Holmes Jan. 9, 2015, 8:44 p.m. UTC | #2
On 9 January 2015 at 09:15, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:

> On Thu, Jan 8, 2015 at 8:34 PM, Mike Holmes <mike.holmes@linaro.org>
> wrote:
> > Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> > ---
> >  configure.ac | 14 +++++++-------
> >  1 file changed, 7 insertions(+), 7 deletions(-)
> >
> > diff --git a/configure.ac b/configure.ac
> > index f0ce7e0..440cc63 100644
> > --- a/configure.ac
> > +++ b/configure.ac
> > @@ -44,16 +44,16 @@ AC_TYPE_UINT64_T
> >  # Determine which platform to build for
> >
> ##########################################################################
> >  AC_ARG_WITH([platform],
> > -    [AS_HELP_STRING([--with-platform=prefix],
> > -        [Select platform to be used, default linux-generic])],
> > +    [AS_HELP_STRING([--with-platform=platform],
> > +        [select platform to be used, default linux-generic])],
> >      [],
> >      [with_platform=linux-generic])
> >
> >  AC_SUBST([with_platform])
> >
> >  AC_ARG_WITH([sdk-install-path],
> > -AC_HELP_STRING([--with-sdk-install-path=DIR Path to external libs and
> headers],
> > -               [(or in the default path if not specified).]),
> > +AC_HELP_STRING([--with-sdk-install-path=DIR path to external libs and
> headers],
> > +             [(or in the default path if not specified).]),
> >  [SDK_INSTALL_PATH=$withval SDK_INSTALL_PATH_=1],[SDK_INSTALL_PATH_=])
> >
> >  AC_SUBST(SDK_INSTALL_PATH)
> > @@ -86,7 +86,7 @@ AC_HELP_STRING([--with-cunit-path=DIR Path to Cunit
> libs and headers],
> >
> ##########################################################################
> >  ODP_DEBUG_PRINT=1
> >  AC_ARG_ENABLE([debug-print],
> > -    [  --enable-debug-print         Enable/disable debug print],
> > +    [  --enable-debug-print    display debugging information],
> >      [if ! test "x$enableval" = "xyes"; then
> >          ODP_DEBUG_PRINT=0
> >      fi])
> > @@ -97,7 +97,7 @@ ODP_CFLAGS="$ODP_CFLAGS
> -DODP_DEBUG_PRINT=$ODP_DEBUG_PRINT"
> >
> ##########################################################################
> >  ODP_DEBUG=1
> >  AC_ARG_ENABLE([debug],
> > -    [  --enable-debug         Enable/disable debug],
> > +    [  --enable-debug          include additional code],
>
> This is only used by ODP_ASSERT, is that what 'additional code' means?
>

ODP_DEBUG could be used for any list of debug features - I agree we don't
have many right now and usualy entails doing something extra that would not
normally be there.

I am open to better text that is not a repeat of "enable debug"


> >      [if ! test "x$enableval" = "xyes"; then
> >          ODP_DEBUG=0
> >      fi])
> > @@ -129,7 +129,7 @@ AM_CONDITIONAL([HAVE_DOXYGEN], [test "x${DOXYGEN}" =
> "xdoxygen"])
> >  # Set optional OpenSSL path
> >
> ##########################################################################
> >  AC_ARG_WITH([openssl-path],
> > -AC_HELP_STRING([--with-openssl-path=DIR Path to openssl libs and
> headers],
> > +AC_HELP_STRING([--with-openssl-path=DIR path to openssl libs and
> headers],
> >                 [(or in the default path if not specified).]),
> >      [OPENSSL_PATH=$withval
> >      AM_CPPFLAGS="$AM_CPPFLAGS -I$OPENSSL_PATH/include"
> > --
> > 2.1.0
> >
> >
> > _______________________________________________
> > lng-odp mailing list
> > lng-odp@lists.linaro.org
> > http://lists.linaro.org/mailman/listinfo/lng-odp
>
Ciprian Barbu Jan. 12, 2015, 9:07 a.m. UTC | #3
On Fri, Jan 9, 2015 at 10:44 PM, Mike Holmes <mike.holmes@linaro.org> wrote:
>
>
> On 9 January 2015 at 09:15, Ciprian Barbu <ciprian.barbu@linaro.org> wrote:
>>
>> On Thu, Jan 8, 2015 at 8:34 PM, Mike Holmes <mike.holmes@linaro.org>
>> wrote:
>> > Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
>> > ---
>> >  configure.ac | 14 +++++++-------
>> >  1 file changed, 7 insertions(+), 7 deletions(-)
>> >
>> > diff --git a/configure.ac b/configure.ac
>> > index f0ce7e0..440cc63 100644
>> > --- a/configure.ac
>> > +++ b/configure.ac
>> > @@ -44,16 +44,16 @@ AC_TYPE_UINT64_T
>> >  # Determine which platform to build for
>> >
>> > ##########################################################################
>> >  AC_ARG_WITH([platform],
>> > -    [AS_HELP_STRING([--with-platform=prefix],
>> > -        [Select platform to be used, default linux-generic])],
>> > +    [AS_HELP_STRING([--with-platform=platform],
>> > +        [select platform to be used, default linux-generic])],
>> >      [],
>> >      [with_platform=linux-generic])
>> >
>> >  AC_SUBST([with_platform])
>> >
>> >  AC_ARG_WITH([sdk-install-path],
>> > -AC_HELP_STRING([--with-sdk-install-path=DIR Path to external libs and
>> > headers],
>> > -               [(or in the default path if not specified).]),
>> > +AC_HELP_STRING([--with-sdk-install-path=DIR path to external libs and
>> > headers],
>> > +             [(or in the default path if not specified).]),
>> >  [SDK_INSTALL_PATH=$withval SDK_INSTALL_PATH_=1],[SDK_INSTALL_PATH_=])
>> >
>> >  AC_SUBST(SDK_INSTALL_PATH)
>> > @@ -86,7 +86,7 @@ AC_HELP_STRING([--with-cunit-path=DIR Path to Cunit
>> > libs and headers],
>> >
>> > ##########################################################################
>> >  ODP_DEBUG_PRINT=1
>> >  AC_ARG_ENABLE([debug-print],
>> > -    [  --enable-debug-print         Enable/disable debug print],
>> > +    [  --enable-debug-print    display debugging information],
>> >      [if ! test "x$enableval" = "xyes"; then
>> >          ODP_DEBUG_PRINT=0
>> >      fi])
>> > @@ -97,7 +97,7 @@ ODP_CFLAGS="$ODP_CFLAGS
>> > -DODP_DEBUG_PRINT=$ODP_DEBUG_PRINT"
>> >
>> > ##########################################################################
>> >  ODP_DEBUG=1
>> >  AC_ARG_ENABLE([debug],
>> > -    [  --enable-debug         Enable/disable debug],
>> > +    [  --enable-debug          include additional code],
>>
>> This is only used by ODP_ASSERT, is that what 'additional code' means?
>
>
> ODP_DEBUG could be used for any list of debug features - I agree we don't
> have many right now and usualy entails doing something extra that would not
> normally be there.
>
> I am open to better text that is not a repeat of "enable debug"

How about "Enable extra checks and debug code" or a minor rephrasing
or yours, "Include additional debug code"? Repeating the word debug
doesn't look bad to me.
>
>>
>> >      [if ! test "x$enableval" = "xyes"; then
>> >          ODP_DEBUG=0
>> >      fi])
>> > @@ -129,7 +129,7 @@ AM_CONDITIONAL([HAVE_DOXYGEN], [test "x${DOXYGEN}" =
>> > "xdoxygen"])
>> >  # Set optional OpenSSL path
>> >
>> > ##########################################################################
>> >  AC_ARG_WITH([openssl-path],
>> > -AC_HELP_STRING([--with-openssl-path=DIR Path to openssl libs and
>> > headers],
>> > +AC_HELP_STRING([--with-openssl-path=DIR path to openssl libs and
>> > headers],
>> >                 [(or in the default path if not specified).]),
>> >      [OPENSSL_PATH=$withval
>> >      AM_CPPFLAGS="$AM_CPPFLAGS -I$OPENSSL_PATH/include"
>> > --
>> > 2.1.0
>> >
>> >
>> > _______________________________________________
>> > lng-odp mailing list
>> > lng-odp@lists.linaro.org
>> > http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> --
> Mike Holmes
> Linaro  Sr Technical Manager
> LNG - ODP
diff mbox

Patch

diff --git a/configure.ac b/configure.ac
index f0ce7e0..440cc63 100644
--- a/configure.ac
+++ b/configure.ac
@@ -44,16 +44,16 @@  AC_TYPE_UINT64_T
 # Determine which platform to build for
 ##########################################################################
 AC_ARG_WITH([platform],
-    [AS_HELP_STRING([--with-platform=prefix],
-        [Select platform to be used, default linux-generic])],
+    [AS_HELP_STRING([--with-platform=platform],
+        [select platform to be used, default linux-generic])],
     [],
     [with_platform=linux-generic])
 
 AC_SUBST([with_platform])
 
 AC_ARG_WITH([sdk-install-path],
-AC_HELP_STRING([--with-sdk-install-path=DIR Path to external libs and headers],
-               [(or in the default path if not specified).]),
+AC_HELP_STRING([--with-sdk-install-path=DIR path to external libs and headers],
+             [(or in the default path if not specified).]),
 [SDK_INSTALL_PATH=$withval SDK_INSTALL_PATH_=1],[SDK_INSTALL_PATH_=])
 
 AC_SUBST(SDK_INSTALL_PATH)
@@ -86,7 +86,7 @@  AC_HELP_STRING([--with-cunit-path=DIR Path to Cunit libs and headers],
 ##########################################################################
 ODP_DEBUG_PRINT=1
 AC_ARG_ENABLE([debug-print],
-    [  --enable-debug-print         Enable/disable debug print],
+    [  --enable-debug-print    display debugging information],
     [if ! test "x$enableval" = "xyes"; then
         ODP_DEBUG_PRINT=0
     fi])
@@ -97,7 +97,7 @@  ODP_CFLAGS="$ODP_CFLAGS -DODP_DEBUG_PRINT=$ODP_DEBUG_PRINT"
 ##########################################################################
 ODP_DEBUG=1
 AC_ARG_ENABLE([debug],
-    [  --enable-debug         Enable/disable debug],
+    [  --enable-debug          include additional code],
     [if ! test "x$enableval" = "xyes"; then
         ODP_DEBUG=0
     fi])
@@ -129,7 +129,7 @@  AM_CONDITIONAL([HAVE_DOXYGEN], [test "x${DOXYGEN}" = "xdoxygen"])
 # Set optional OpenSSL path
 ##########################################################################
 AC_ARG_WITH([openssl-path],
-AC_HELP_STRING([--with-openssl-path=DIR Path to openssl libs and headers],
+AC_HELP_STRING([--with-openssl-path=DIR path to openssl libs and headers],
                [(or in the default path if not specified).]),
     [OPENSSL_PATH=$withval
     AM_CPPFLAGS="$AM_CPPFLAGS -I$OPENSSL_PATH/include"