mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-23 00:41:02 +00:00
Improve documentation
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@22155 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS
parent
c3b817b927
commit
767759c655
4 changed files with 111 additions and 33 deletions
|
|
@ -7,7 +7,7 @@
|
|||
.GNUstep.conf-ignore (so we can safely disable config file reading
|
||||
and ensure inbuilt defaults are used)
|
||||
* configure.ac: By default, disallow use of GNUSTEP_CONFIG_FILE
|
||||
environment variable. Remove some redundant code.
|
||||
environment variable. Remove some redundant code. Document better.
|
||||
* configure: regenerate
|
||||
* Documentation/Base.gsdoc: Update for config changes
|
||||
* Tools/autogsdoc.m: add any gsdoc files explicitly specified on
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ dnl This macro defines HAVE_PROCFS_PSINFO if it can read the psinfo
|
|||
dnl structure from the /proc/%pid% directory
|
||||
AC_DEFUN(AC_SYS_PROCFS_PSINFO,
|
||||
[ AC_ARG_ENABLE(procfs-psinfo,
|
||||
[ --enable-procfs-psinfo Use /proc/%pid% to get info],
|
||||
[ --enable-procfs-psinfo Use /proc/%pid% to get info],
|
||||
enable_procfs_psinfo="$enableval", if test "$cross_compiling" = yes; then enable_procfs_psinfo=cross; else enable_procfs_psinfo=yes; fi;)
|
||||
|
||||
AC_CACHE_CHECK([support for /proc psinfo struct], ac_cv_sys_procfs_psinfo,
|
||||
|
|
|
|||
71
configure
vendored
71
configure
vendored
|
|
@ -846,10 +846,22 @@ if test -n "$ac_init_help"; then
|
|||
Optional Features:
|
||||
--disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
|
||||
--enable-FEATURE[=ARG] include FEATURE [ARG=yes]
|
||||
--enable-environment-config-file Enable use of the GNUSTEP_CONFIG_FILE environment variable
|
||||
--disable-importing-config-file Disable importing the existing GNUstep configuration file
|
||||
--enable-environment-config-file
|
||||
Enable use of the GNUSTEP_CONFIG_FILE
|
||||
environment variable to specify/override
|
||||
the location of the GNUstep config file
|
||||
at runtime. This option is occasionally
|
||||
useful for development/debugging or for
|
||||
providing a relocatable distribution package
|
||||
for platforms where the path to the base
|
||||
library can't be determined at runtime
|
||||
and the leading './' in the config file name
|
||||
is therefore not supported.
|
||||
--disable-importing-config-file
|
||||
Disable importing of an existing GNUstep config
|
||||
file and use inbuilt defaults instead.
|
||||
--enable-procfs Use /proc filesystem (default)
|
||||
--enable-procfs-psinfo Use /proc/%pid% to get info
|
||||
--enable-procfs-psinfo Use /proc/%pid% to get info
|
||||
--enable-pass-arguments Force user main call to NSProcessInfo initialize
|
||||
--enable-fake-main Force redefine of user main function
|
||||
--enable-libffi Enable use of libffi library
|
||||
|
|
@ -863,13 +875,28 @@ Optional Features:
|
|||
Optional Packages:
|
||||
--with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
|
||||
--without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
|
||||
--with-config-file=PATH path to GNUstep configuration file
|
||||
--with-default-config=PATH path to file with default GNUstep config
|
||||
--with-include-flags=FLAGS specify all include flags at once
|
||||
--with-library-flags=FLAGS specify all library flags at once
|
||||
--with-ffi-include=PATH include path for ffi (ffcall/libffi) headers
|
||||
--with-ffi-library=PATH library path for ffi (ffcall/libffi) libraries
|
||||
--with-libiconv-library=PATH library path for libiconv libraries
|
||||
--with-config-file=PATH Specify path to the GNUstep config file.
|
||||
If unspecified, uses the same value as the
|
||||
GNUstep make package.
|
||||
If a leading './' is specified, the path
|
||||
is taken to be relative to the base library
|
||||
linked runtime, not all operating systems
|
||||
can support this, so on some platforms you
|
||||
may need --enable-environment-config-file.
|
||||
If a trailing '/' is specified, the path is
|
||||
used for locating domains but no GNUstep
|
||||
config file is read at runtime.
|
||||
--with-defaults-config=PATH Specify path to a GNUstep config file to be
|
||||
imported at configure time (now) and used to
|
||||
provide default values for the base library
|
||||
to use at runtime if no GNUstep config file
|
||||
is found at runtime. If this is not specified
|
||||
then the path from --with-config-file is used.
|
||||
--with-include-flags=FLAGS Specify all include flags at once
|
||||
--with-library-flags=FLAGS Specify all library flags at once
|
||||
--with-ffi-include=PATH Include path for ffi (ffcall/libffi) headers
|
||||
--with-ffi-library=PATH Library path for ffi (ffcall/libffi) libs
|
||||
--with-libiconv-library=PATH Library path for libiconv libraries
|
||||
--with-xml-prefix=PFX Prefix where libxml is installed (optional)
|
||||
--with-gmp-include=PATH include path for gmp headers
|
||||
--with-gmp-library=PATH library path for gmp libraries
|
||||
|
|
@ -1383,12 +1410,24 @@ fi
|
|||
#
|
||||
# Set 'standard' defaults for values from configuration file.
|
||||
#
|
||||
GNUSTEP_SYSTEM_ROOT=/usr/GNUstep/System
|
||||
GNUSTEP_LOCAL_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_NETWORK_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep/Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
case "$target_os" in
|
||||
mingw*)
|
||||
GNUSTEP_SYSTEM_ROOT=RC:\\GNUstep\\System
|
||||
GNUSTEP_LOCAL_ROOT=C:\\GNUstep\\Local
|
||||
GNUSTEP_NETWORK_ROOT=C:\\GNUstep\\Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep\\Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
;;
|
||||
*)
|
||||
GNUSTEP_SYSTEM_ROOT=/usr/GNUstep/System
|
||||
GNUSTEP_LOCAL_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_NETWORK_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep/Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
;;
|
||||
esac
|
||||
|
||||
#---------------------------------------------------------------------
|
||||
# Now read/import the existing configuration file, if any
|
||||
|
|
|
|||
69
configure.ac
69
configure.ac
|
|
@ -40,7 +40,17 @@ fi
|
|||
#---------------------------------------------------------------------
|
||||
AC_MSG_CHECKING([for GNUstep configuration file to use])
|
||||
AC_ARG_WITH(config-file,
|
||||
[--with-config-file=PATH path to GNUstep configuration file],
|
||||
[ --with-config-file=PATH Specify path to the GNUstep config file.
|
||||
If unspecified, uses the same value as the
|
||||
GNUstep make package.
|
||||
If a leading './' is specified, the path
|
||||
is taken to be relative to the base library
|
||||
linked runtime, not all operating systems
|
||||
can support this, so on some platforms you
|
||||
may need --enable-environment-config-file.
|
||||
If a trailing '/' is specified, the path is
|
||||
used for locating domains but no GNUstep
|
||||
config file is read at runtime.],
|
||||
GNUSTEP_CONFIG_FILE="$withval",
|
||||
[if test "$GNUSTEP_CONFIG_FILE" = ""; then
|
||||
GNUSTEP_CONFIG_FILE=`grep '^GNUSTEP_CONFIG_FILE *=' $GNUSTEP_MAKEFILES/config.make | sed -e 's/GNUSTEP_CONFIG_FILE *= *\(.*\)/\1/'`
|
||||
|
|
@ -53,7 +63,17 @@ AC_SUBST(GNUSTEP_CONFIG_FILE)
|
|||
#-----------------------------------------------------------------
|
||||
AC_MSG_CHECKING([whether the GNUstep.conf file path can be set in the environment])
|
||||
AC_ARG_ENABLE(environment-config-file,
|
||||
[--enable-environment-config-file Enable use of the GNUSTEP_CONFIG_FILE environment variable],
|
||||
[ --enable-environment-config-file
|
||||
Enable use of the GNUSTEP_CONFIG_FILE
|
||||
environment variable to specify/override
|
||||
the location of the GNUstep config file
|
||||
at runtime. This option is occasionally
|
||||
useful for development/debugging or for
|
||||
providing a relocatable distribution package
|
||||
for platforms where the path to the base
|
||||
library can't be determined at runtime
|
||||
and the leading './' in the config file name
|
||||
is therefore not supported.],
|
||||
ac_cv_environment_config_file=$enableval,
|
||||
ac_cv_environment_config_file="no")
|
||||
if test "$ac_cv_environment_config_file" = "yes"; then
|
||||
|
|
@ -69,12 +89,24 @@ fi
|
|||
#
|
||||
# Set 'standard' defaults for values from configuration file.
|
||||
#
|
||||
GNUSTEP_SYSTEM_ROOT=/usr/GNUstep/System
|
||||
GNUSTEP_LOCAL_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_NETWORK_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep/Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
case "$target_os" in
|
||||
mingw*)
|
||||
GNUSTEP_SYSTEM_ROOT=RC:\\GNUstep\\System
|
||||
GNUSTEP_LOCAL_ROOT=C:\\GNUstep\\Local
|
||||
GNUSTEP_NETWORK_ROOT=C:\\GNUstep\\Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep\\Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
;;
|
||||
*)
|
||||
GNUSTEP_SYSTEM_ROOT=/usr/GNUstep/System
|
||||
GNUSTEP_LOCAL_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_NETWORK_ROOT=/usr/GNUstep/Local
|
||||
GNUSTEP_USER_DIR=GNUstep
|
||||
GNUSTEP_USER_DEFAULTS_DIR=GNUstep/Defaults
|
||||
GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
||||
;;
|
||||
esac
|
||||
|
||||
#---------------------------------------------------------------------
|
||||
# Now read/import the existing configuration file, if any
|
||||
|
|
@ -87,7 +119,9 @@ GNUSTEP_USER_CONFIG_FILE=.GNUstep.conf
|
|||
# turn it off
|
||||
AC_MSG_CHECKING([if we should import an existing configuration file])
|
||||
AC_ARG_ENABLE(importing-config-file,
|
||||
[--disable-importing-config-file Disable importing the existing GNUstep configuration file],
|
||||
[ --disable-importing-config-file
|
||||
Disable importing of an existing GNUstep config
|
||||
file and use inbuilt defaults instead.],
|
||||
ac_cv_importing_config_file=$enableval,
|
||||
ac_cv_importing_config_file="yes")
|
||||
if test "$ac_cv_importing_config_file" = "no"; then
|
||||
|
|
@ -101,7 +135,12 @@ if test "$ac_cv_importing_config_file" = "yes" ;
|
|||
then
|
||||
AC_MSG_CHECKING([for default GNUstep configuration file to use])
|
||||
AC_ARG_WITH(default-config,
|
||||
[--with-default-config=PATH path to file with default GNUstep config],
|
||||
[ --with-defaults-config=PATH Specify path to a GNUstep config file to be
|
||||
imported at configure time (now) and used to
|
||||
provide default values for the base library
|
||||
to use at runtime if no GNUstep config file
|
||||
is found at runtime. If this is not specified
|
||||
then the path from --with-config-file is used.],
|
||||
GNUSTEP_DEFAULT_CONFIG="$withval",
|
||||
[if test "$GNUSTEP_DEFAULT_CONFIG" = ""; then
|
||||
GNUSTEP_DEFAULT_CONFIG="$GNUSTEP_CONFIG_FILE"
|
||||
|
|
@ -1072,7 +1111,7 @@ AC_MSG_RESULT($enable_fake_main)
|
|||
# Simple way to add a bunch of paths to the flags
|
||||
#--------------------------------------------------------------------
|
||||
AC_ARG_WITH(include-flags,
|
||||
[ --with-include-flags=FLAGS specify all include flags at once],
|
||||
[ --with-include-flags=FLAGS Specify all include flags at once],
|
||||
include_flags="$withval", include_flags="no")
|
||||
if test ${include_flags} != "no"; then
|
||||
CPPFLAGS="$CPPFLAGS ${include_flags}"
|
||||
|
|
@ -1080,7 +1119,7 @@ if test ${include_flags} != "no"; then
|
|||
fi
|
||||
|
||||
AC_ARG_WITH(library-flags,
|
||||
[ --with-library-flags=FLAGS specify all library flags at once],
|
||||
[ --with-library-flags=FLAGS Specify all library flags at once],
|
||||
library_flags="$withval", library_flags="no")
|
||||
if test ${library_flags} != "no"; then
|
||||
LDFLAGS="$LDFLAGS ${library_flags}"
|
||||
|
|
@ -1115,7 +1154,7 @@ if test $LIBRARY_COMBO = apple-apple-apple; then
|
|||
fi
|
||||
|
||||
AC_ARG_WITH(ffi-include,
|
||||
[ --with-ffi-include=PATH include path for ffi (ffcall/libffi) headers],
|
||||
[ --with-ffi-include=PATH Include path for ffi (ffcall/libffi) headers],
|
||||
ffi_incdir="$withval", ffi_incdir="no")
|
||||
if test ${ffi_incdir} != "no"; then
|
||||
CPPFLAGS="$CPPFLAGS -I${ffi_incdir}"
|
||||
|
|
@ -1123,7 +1162,7 @@ if test ${ffi_incdir} != "no"; then
|
|||
fi
|
||||
|
||||
AC_ARG_WITH(ffi-library,
|
||||
[ --with-ffi-library=PATH library path for ffi (ffcall/libffi) libraries],
|
||||
[ --with-ffi-library=PATH Library path for ffi (ffcall/libffi) libs],
|
||||
ffi_libdir="$withval", ffi_libdir="no")
|
||||
if test ${ffi_libdir} != "no"; then
|
||||
LDFLAGS="$LDFLAGS -L${ffi_libdir}"
|
||||
|
|
@ -1238,7 +1277,7 @@ if test $found_iconv = no ; then
|
|||
# libc doesn't have a working iconv. Try adding -liconv and any user
|
||||
# supplied directory.
|
||||
AC_ARG_WITH(libiconv-library,
|
||||
[ --with-libiconv-library=PATH library path for libiconv libraries],
|
||||
[ --with-libiconv-library=PATH Library path for libiconv libraries],
|
||||
libiconv_libdir="$withval", libiconv_libdir="no")
|
||||
|
||||
if test "$libiconv_libdir" != "no"; then
|
||||
|
|
|
|||
Loading…
Reference in a new issue