From 90c01ac9dfb0ce6cc126e4977cf171a946c5728f Mon Sep 17 00:00:00 2001 From: Joshua Daniel Franklin Date: Fri, 27 Jan 2006 05:37:13 +0000 Subject: [PATCH] Add top-level README --- winsup/README | 9 ++++++ winsup/doc/ChangeLog | 5 ++++ winsup/doc/faq-programming.xml | 54 +++++++++++++++------------------- 3 files changed, 37 insertions(+), 31 deletions(-) create mode 100644 winsup/README diff --git a/winsup/README b/winsup/README new file mode 100644 index 000000000..290275cd7 --- /dev/null +++ b/winsup/README @@ -0,0 +1,9 @@ +THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +Cygwin documentation is available on the net at http://cygwin.com +You might especially be interested in + +http://cygwin.com/faq/faq.programming.html#faq.programming.building-cygwin + diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index d4701982b..06250aba0 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,3 +1,8 @@ +2006-01-26 Joshua Daniel Franklin + + * faq-programming.xml (faq.programming.building-cygwin): + Simplify instructions, and remove tar usage basics. + 2006-01-26 Joshua Daniel Franklin * faq-programming.xml (faq.programming.ipc): Add new FAQ about diff --git a/winsup/doc/faq-programming.xml b/winsup/doc/faq-programming.xml index 2f3d9c1e7..d4035a5ad 100644 --- a/winsup/doc/faq-programming.xml +++ b/winsup/doc/faq-programming.xml @@ -438,44 +438,36 @@ rewriting the runtime library in question from specs... First, you need to make sure you have the necessary build tools installed; you at least need gcc, make, -and perl. If you want to run the tests +and perl. If you want to run the tests, cocom and dejagnu are also required, and you need to have CYGWIN=server set as described at . - -Next, get the Cygwin source. Ideally, you should check out -what you need from CVS (). This is the -preferred method for acquiring the sources. Otherwise, you can -install the cygwin source package from the distribution. - -If you are trying to duplicate a cygwin release then you should just -download the corresponding source package and use "tar xjf" to unpack -it. This will unpack the sources into a directory named cygwin-x.y.z-n, -where x.y.z-n correspond to the version numbering of the tar.bz2 -package. - - -tar xjf cygwin-1.5.12-1-src.tar.bz2 -cd cygwin-1.5.12-1 - - -You must build cygwin in a separate directory from the source, -so create something like a build/ directory. You will also want -to install to a temporary location: - - -mkdir build -mkdir /install -cd build -(../configure --prefix=/install -v; make) >& make.out -make install > install.log 2>&1 - - -Normally, this procedure ignores errors in building the documentation. +Normally, building ignores any errors in building the documentation, which requires the docbook-xml42, docbook-xsl, and xmlto packages. For more information on building the documentation, see the README included in the cygwin-doc package. + +Next, get the Cygwin source. Ideally, you should check out +what you need from CVS (). This is the +preferred method for acquiring the sources. Otherwise, if +you are trying to duplicate a cygwin release then you should +download the corresponding source package +(cygwin-x.y.z-n-src.tar.bz2). + +You must build cygwin in a separate directory from +the source, so create something like a build/ directory. +Assuming you checked out the source in /oss/src/, and you +also want to install to the temporary location install: + + +mkdir /oss/build +mkdir /oss/install +cd build +(/oss/src/configure --prefix=/oss/install -v; make) >& make.out +make install > install.log 2>&1 + + To check a cygwin1.dll, run "make check" in the winsup/testsuite directory. If that works, install everything except the dll (if you can). Then, close down all cygwin programs (including bash windows,