Use kconfig- prefix to avoid tool name conflicts (from Jose Pablo Carballo)

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5496 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 48 insertions, 13 deletions

diff --git a/misc/tools/README.txt b/misc/tools/README.txt
index 512d8ebaa..1546c6f39 100644
--- a/misc/tools/README.txt
+++ b/misc/tools/README.txt
@@ -1,8 +1,18 @@
 misc/tools/README.txt
 =====================
 
+Contents:
+
+  o genromfs-0.5.2.tar.gz
+  o kconfig-frontends
+    - --program-prefix=
+    - kconfig-frontends-3.3.0-1-libintl.patch
+    - kconfig-macos.patch
+    - kconfig-macos.patch
+    - kconfig-frontends for Windows
+
 genromfs-0.5.2.tar.gz
----------------------
+=====================
 
   This is a snapshot of the genromfs tarball taken from
   http://sourceforge.net/projects/romfs/.  This snapshot is provided to
@@ -12,34 +22,60 @@ genromfs-0.5.2.tar.gz
   from the buildroot.
 
 kconfig-frontends
------------------
+=================
 
-  This is a snapshot of the kconfig-frontends version 3.6.0 tarball taken
+  This is a snapshot of the kconfig-frontends version 3.7.0 tarball taken
   from http://ymorin.is-a-geek.org/projects/kconfig-frontends.
 
   General build instructions:
 
     cd kconfig-frontends
-    ./configure --program-prefix=
+    ./configure
     make
     make install
 
-  If you do not specify --program-prefix= in the configuration, then the
-  current kconfig-frontends code will add the prefix kconfig- to the generated
-  tools.
+  To suppress the nconf and the graphical interfaces which are not used by
+  NuttX:
+
+    ./configure --disable-gconf --disable-qconf
+    make
+    make install
 
-  To suppress the graphical interfaces:
+  To suppress the graphical interfaces, use static libraries, and disable
+  creation of other utilities:
 
-    ./configure --disable-gconf --disable-qconf --program-prefix=
+    ./configure --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf --disable-utils
     make
     make install
 
+  You may require root privileges to 'make install'.
+
+--program-prefix=
+-----------------
+
+  Beginning somwhere between version 3.3.0 and 3.6.0, the prefix was added
+  to the kconfig-frontends tools.  The default prefix is kconfig-.  So,
+  after 3.3.0, conf becomes kconfig-conf, mconf becomes kconfig-mconf, etc.
+  All of the NuttX documentation, Makefiles, scripts have been updated to
+  used this default prefix.
+
+  This introduces an incompatibility with the 3.3.0 version.  In the 3.6.0
+  timeframe, the configure argument --program-prefix= was added to
+  eliminated the kconfig- prefix.  This, however, caused problems when we
+  got to the 3.7.0 version which generates a binary called kconfig-diff
+  (installed at /usr/local/bin).  Without the prefix, may conflict with
+  the standard diff utility (at /bin), depending upon how your PATH
+  variable is configured.  Because of this, we decided to "bite the bullet"
+  and use the standard prefix at 3.7.0 and later.
+
+  This problem could probably also be avoided using --disable-utils.
+
 kconfig-frontends-3.3.0-1-libintl.patch
 ---------------------------------------
 
   The above build instructions did not work for me under my Cygwin
   installation with kconfig-frontends-3.3.0.  This patch is a awful hack
-  but will successfully build 'mconf' under Cygwin.
+  but will successfully build 'kconfig-mconf' under Cygwin.
 
     cat kconfig-frontends-3.3.0-1-libintl.patch | patch -p0
     cd kconfig-frontends-3.3.0-1
@@ -49,8 +85,7 @@ kconfig-frontends-3.3.0-1-libintl.patch
 
   See: http://ymorin.is-a-geek.org/hg/kconfig-frontends/file/tip/docs/known-issues.txt
 
-  Update: According to the release notes, version 3.6.0 (and above)
-  will build on Cygwin with no patches: 
+  Update: Version 3.6.0 (and above) will build on Cygwin with no patches: 
 
     http://ymorin.is-a-geek.org/download/kconfig-frontends/
 
@@ -66,7 +101,7 @@ kconfig-macos.patch
     make install
 
 kconfig-frontends for Windows
-=============================
+-----------------------------
 
 From http://tech.groups.yahoo.com/group/nuttx/message/2900: