From e6fc427ccccea996d206a60ea0cc5602cc625de7 Mon Sep 17 00:00:00 2001
From: Mark Reynolds <mreynolds@redhat.com>
Date: Feb 13 2020 01:19:58 +0000
Subject: Issue 49845 - README does not contain complete information on building


Description:  Update READNME.md with clearer instructions and requirements
              for building the server.  Also added a check for libasan
              to configure.am.

relates: https://pagure.io/389-ds-base/issue/49845

Reviewed by: firstyear(Thanks!)

---

diff --git a/README.md b/README.md
index a442232..2cfe5f4 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,70 @@ license agreement file called LICENSE.
 Late-breaking news and information on the 389 Directory Server is
 available on our wiki page:
 
-    http://www.port389.org/
+    https://www.port389.org/
+
+Build Requirements (as of 2020-02-12)
+-------------------------------------
+
+nspr-devel
+nss-devel
+perl-generators
+openldap-devel
+libdb-devel
+cyrus-sasl-devel
+icu
+libicu-devel
+pcre-devel
+cracklib-devel
+libatomic
+clang
+gcc
+gcc-c++
+net-snmp-devel
+lm_sensors-devel
+bzip2-devel
+zlib-devel
+openssl-devel
+pam-devel
+systemd-units
+systemd-devel
+libasan
+cargo
+rust
+pkgconfig
+pkgconfig(systemd)
+pkgconfig(krb5)
+autoconf
+automake
+libtool
+doxygen
+libcmocka-devel
+libevent-devel
+python3-devel
+python3-setuptools
+python3-ldap
+python3-six
+python3-pyasn1
+python3-pyasn1-modules
+python3-dateutil
+python3-argcomplete
+python3-argparse-manpage
+python3-libselinux
+python3-policycoreutils
+rsync
+npm
+nodejs
+nspr-devel
+nss-devel
+openldap-devel
+libdb-devel
+cyrus-sasl-devel
+libicu-devel
+pcre-devel
+libtalloc-devel
+libevent-devel
+libtevent-devel
+systemd-devel
 
 Building
 --------
@@ -30,6 +93,10 @@ Building
     sudo make install
     sudo make lib389-install
 
+Note: **--enable-asan** is optional, and it should only be used for debugging/development purposes.
+
+See also:  <https://www.port389.org/docs/389ds/development/building.html>
+
 Testing
 -------
 
@@ -45,5 +112,5 @@ More information
 
 Please see our contributing guide online:
 
-    http://www.port389.org/docs/389ds/contributing.html
+    https://www.port389.org/docs/389ds/contributing.html
 
diff --git a/configure.ac b/configure.ac
index 95772d7..78803cc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -150,6 +150,7 @@ AC_ARG_ENABLE(asan, AS_HELP_STRING([--enable-asan], [Enable gcc/clang address sa
               [], [ enable_asan=no ])
 AC_MSG_RESULT($enable_asan)
 if test "$enable_asan" = yes ; then
+  PKG_CHECK_MODULES([ASAN], [libasan])
   asan_cflags="-fsanitize=address -fno-omit-frame-pointer -lasan"
   asan_rust_defs="-Z sanitizer=address"
 else