* [PATCH] configure: add --without-api-docs option
@ 2016-08-09 10:52 mp39590
2016-08-09 14:05 ` David Bremner
0 siblings, 1 reply; 6+ messages in thread
From: mp39590 @ 2016-08-09 10:52 UTC (permalink / raw)
To: notmuch
From: Mikhail <mp39590@gmail.com>
Add option to explicitly disable API man page build even if doxygen is
available.
---
configure | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index ae0a027..a6b6ee8 100755
--- a/configure
+++ b/configure
@@ -68,6 +68,7 @@ PYTHON=${PYTHON:-}
PREFIX=/usr/local
LIBDIR=
WITH_DOCS=1
+WITH_API_DOCS=1
WITH_EMACS=1
WITH_BASH=1
WITH_RUBY=1
@@ -137,7 +138,8 @@ Some features can be disabled (--with-feature=no is equivalent to
--without-feature) :
--without-bash-completion Do not install bash completions files
- --without-docs Do not install documentation and man pages
+ --without-docs Do not install man pages
+ --without-api-docs Do not install API documentation
--without-emacs Do not install lisp file
--without-ruby Do not install ruby bindings
--without-zsh-completion Do not install zsh completions files
@@ -189,6 +191,14 @@ for option; do
fi
elif [ "${option}" = '--without-docs' ] ; then
WITH_DOCS=0
+ elif [ "${option%%=*}" = '--with-api-docs' ]; then
+ if [ "${option#*=}" = 'no' ]; then
+ WITH_API_DOCS=0
+ else
+ WITH_API_DOCS=1
+ fi
+ elif [ "${option}" = '--without-api-docs' ] ; then
+ WITH_API_DOCS=0
elif [ "${option%%=*}" = '--with-emacs' ]; then
if [ "${option#*=}" = 'no' ]; then
WITH_EMACS=0
@@ -557,7 +567,7 @@ else
fi
have_doxygen=0
-if [ $WITH_DOCS = "1" ] ; then
+if [ $WITH_API_DOCS = "1" ] ; then
printf "Checking if doxygen is available... "
if command -v doxygen > /dev/null; then
printf "Yes.\n"
--
2.9.0
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] configure: add --without-api-docs option
2016-08-09 10:52 [PATCH] configure: add --without-api-docs option mp39590
@ 2016-08-09 14:05 ` David Bremner
2016-08-09 14:59 ` Tomi Ollila
2016-08-10 13:02 ` mp39590
0 siblings, 2 replies; 6+ messages in thread
From: David Bremner @ 2016-08-09 14:05 UTC (permalink / raw)
To: mp39590, notmuch
mp39590@gmail.com writes:
> From: Mikhail <mp39590@gmail.com>
>
> Add option to explicitly disable API man page build even if doxygen is
> available.
I'm not sure about the use case here. For some reason you want to
install some of the man pages, but not all of them?
> ---
> configure | 14 ++++++++++++--
> 1 file changed, 12 insertions(+), 2 deletions(-)
>
> diff --git a/configure b/configure
> index ae0a027..a6b6ee8 100755
> --- a/configure
> +++ b/configure
> @@ -68,6 +68,7 @@ PYTHON=${PYTHON:-}
> PREFIX=/usr/local
> LIBDIR=
> WITH_DOCS=1
> +WITH_API_DOCS=1
> WITH_EMACS=1
> WITH_BASH=1
> WITH_RUBY=1
> @@ -137,7 +138,8 @@ Some features can be disabled (--with-feature=no is equivalent to
> --without-feature) :
>
> --without-bash-completion Do not install bash completions files
> - --without-docs Do not install documentation and man pages
> + --without-docs Do not install man pages
I would say that --without-docs should imply --without-api-docs
I'm not totally convinced about the change in the description, but I
guess we can always change it back if / when we start install other
kinds of docs (e.g. html docs or info pages).
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] configure: add --without-api-docs option
2016-08-09 14:05 ` David Bremner
@ 2016-08-09 14:59 ` Tomi Ollila
2016-08-10 13:02 ` mp39590
1 sibling, 0 replies; 6+ messages in thread
From: Tomi Ollila @ 2016-08-09 14:59 UTC (permalink / raw)
To: David Bremner, mp39590, notmuch
On Tue, Aug 09 2016, David Bremner <david@tethera.net> wrote:
> mp39590@gmail.com writes:
>
>> From: Mikhail <mp39590@gmail.com>
>>
>> Add option to explicitly disable API man page build even if doxygen is
>> available.
>
> I'm not sure about the use case here. For some reason you want to
> install some of the man pages, but not all of them?
I do understand. api docs are for developers, other docs additionally
for rest of the end users
Also, in some of my systems building api docs prints out quite a bit of
noise (old doxygen) and the output is just pile of crap (fortunately i
don't install notmuch in any of my systems where I use it... ok I do it
in one, but into a tree inside my home dir...)
>> ---
>> configure | 14 ++++++++++++--
>> 1 file changed, 12 insertions(+), 2 deletions(-)
>>
>> diff --git a/configure b/configure
>> index ae0a027..a6b6ee8 100755
>> --- a/configure
>> +++ b/configure
>> @@ -68,6 +68,7 @@ PYTHON=${PYTHON:-}
>> PREFIX=/usr/local
>> LIBDIR=
>> WITH_DOCS=1
>> +WITH_API_DOCS=1
>> WITH_EMACS=1
>> WITH_BASH=1
>> WITH_RUBY=1
>> @@ -137,7 +138,8 @@ Some features can be disabled (--with-feature=no is equivalent to
>> --without-feature) :
>>
>> --without-bash-completion Do not install bash completions files
>> - --without-docs Do not install documentation and man pages
>> + --without-docs Do not install man pages
>
> I would say that --without-docs should imply --without-api-docs
on that I agree :)
Tomi
>
> I'm not totally convinced about the change in the description, but I
> guess we can always change it back if / when we start install other
> kinds of docs (e.g. html docs or info pages).
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] configure: add --without-api-docs option
2016-08-09 14:05 ` David Bremner
2016-08-09 14:59 ` Tomi Ollila
@ 2016-08-10 13:02 ` mp39590
2016-08-11 6:16 ` Tomi Ollila
2016-08-11 13:02 ` David Bremner
1 sibling, 2 replies; 6+ messages in thread
From: mp39590 @ 2016-08-10 13:02 UTC (permalink / raw)
To: notmuch; +Cc: David Bremner, Tomi Ollila
From: Mikhail <mp39590@gmail.com>
Add option to explicitly disable API man page build even if doxygen
binary is available. --without-docs also implies not building API
manpage.
This change intended to add more distinctness into build system and
allow user not to build unwanted man pages.
---
configure | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index ae0a027..fa4c5b5 100755
--- a/configure
+++ b/configure
@@ -68,6 +68,7 @@ PYTHON=${PYTHON:-}
PREFIX=/usr/local
LIBDIR=
WITH_DOCS=1
+WITH_API_DOCS=1
WITH_EMACS=1
WITH_BASH=1
WITH_RUBY=1
@@ -137,7 +138,8 @@ Some features can be disabled (--with-feature=no is equivalent to
--without-feature) :
--without-bash-completion Do not install bash completions files
- --without-docs Do not install documentation and man pages
+ --without-docs Do not install documentation
+ --without-api-docs Do not install API man page
--without-emacs Do not install lisp file
--without-ruby Do not install ruby bindings
--without-zsh-completion Do not install zsh completions files
@@ -184,11 +186,21 @@ for option; do
elif [ "${option%%=*}" = '--with-docs' ]; then
if [ "${option#*=}" = 'no' ]; then
WITH_DOCS=0
+ WITH_API_DOCS=0
else
WITH_DOCS=1
fi
elif [ "${option}" = '--without-docs' ] ; then
WITH_DOCS=0
+ WITH_API_DOCS=0
+ elif [ "${option%%=*}" = '--with-api-docs' ]; then
+ if [ "${option#*=}" = 'no' ]; then
+ WITH_API_DOCS=0
+ else
+ WITH_API_DOCS=1
+ fi
+ elif [ "${option}" = '--without-api-docs' ] ; then
+ WITH_API_DOCS=0
elif [ "${option%%=*}" = '--with-emacs' ]; then
if [ "${option#*=}" = 'no' ]; then
WITH_EMACS=0
@@ -557,7 +569,7 @@ else
fi
have_doxygen=0
-if [ $WITH_DOCS = "1" ] ; then
+if [ $WITH_API_DOCS = "1" ] ; then
printf "Checking if doxygen is available... "
if command -v doxygen > /dev/null; then
printf "Yes.\n"
--
2.9.0
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] configure: add --without-api-docs option
2016-08-10 13:02 ` mp39590
@ 2016-08-11 6:16 ` Tomi Ollila
2016-08-11 13:02 ` David Bremner
1 sibling, 0 replies; 6+ messages in thread
From: Tomi Ollila @ 2016-08-11 6:16 UTC (permalink / raw)
To: mp39590, notmuch
On Wed, Aug 10 2016, mp39590@gmail.com wrote:
> From: Mikhail <mp39590@gmail.com>
>
> Add option to explicitly disable API man page build even if doxygen
> binary is available. --without-docs also implies not building API
> manpage.
This LGTM and worked fine on my manual ./configure command line testing
Tomi
>
> This change intended to add more distinctness into build system and
> allow user not to build unwanted man pages.
> ---
> configure | 16 ++++++++++++++--
> 1 file changed, 14 insertions(+), 2 deletions(-)
>
> diff --git a/configure b/configure
> index ae0a027..fa4c5b5 100755
> --- a/configure
> +++ b/configure
> @@ -68,6 +68,7 @@ PYTHON=${PYTHON:-}
> PREFIX=/usr/local
> LIBDIR=
> WITH_DOCS=1
> +WITH_API_DOCS=1
> WITH_EMACS=1
> WITH_BASH=1
> WITH_RUBY=1
> @@ -137,7 +138,8 @@ Some features can be disabled (--with-feature=no is equivalent to
> --without-feature) :
>
> --without-bash-completion Do not install bash completions files
> - --without-docs Do not install documentation and man pages
> + --without-docs Do not install documentation
> + --without-api-docs Do not install API man page
> --without-emacs Do not install lisp file
> --without-ruby Do not install ruby bindings
> --without-zsh-completion Do not install zsh completions files
> @@ -184,11 +186,21 @@ for option; do
> elif [ "${option%%=*}" = '--with-docs' ]; then
> if [ "${option#*=}" = 'no' ]; then
> WITH_DOCS=0
> + WITH_API_DOCS=0
> else
> WITH_DOCS=1
> fi
> elif [ "${option}" = '--without-docs' ] ; then
> WITH_DOCS=0
> + WITH_API_DOCS=0
> + elif [ "${option%%=*}" = '--with-api-docs' ]; then
> + if [ "${option#*=}" = 'no' ]; then
> + WITH_API_DOCS=0
> + else
> + WITH_API_DOCS=1
> + fi
> + elif [ "${option}" = '--without-api-docs' ] ; then
> + WITH_API_DOCS=0
> elif [ "${option%%=*}" = '--with-emacs' ]; then
> if [ "${option#*=}" = 'no' ]; then
> WITH_EMACS=0
> @@ -557,7 +569,7 @@ else
> fi
>
> have_doxygen=0
> -if [ $WITH_DOCS = "1" ] ; then
> +if [ $WITH_API_DOCS = "1" ] ; then
> printf "Checking if doxygen is available... "
> if command -v doxygen > /dev/null; then
> printf "Yes.\n"
> --
> 2.9.0
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> https://notmuchmail.org/mailman/listinfo/notmuch
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] configure: add --without-api-docs option
2016-08-10 13:02 ` mp39590
2016-08-11 6:16 ` Tomi Ollila
@ 2016-08-11 13:02 ` David Bremner
1 sibling, 0 replies; 6+ messages in thread
From: David Bremner @ 2016-08-11 13:02 UTC (permalink / raw)
To: mp39590, notmuch; +Cc: Tomi Ollila
mp39590@gmail.com writes:
> From: Mikhail <mp39590@gmail.com>
>
> Add option to explicitly disable API man page build even if doxygen
> binary is available. --without-docs also implies not building API
> manpage.
>
> This change intended to add more distinctness into build system and
> allow user not to build unwanted man pages.
pushed to master
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2016-08-11 13:02 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-08-09 10:52 [PATCH] configure: add --without-api-docs option mp39590
2016-08-09 14:05 ` David Bremner
2016-08-09 14:59 ` Tomi Ollila
2016-08-10 13:02 ` mp39590
2016-08-11 6:16 ` Tomi Ollila
2016-08-11 13:02 ` David Bremner
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
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 read-only IMAP folder(s) and NNTP newsgroup(s).