You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Gustavo Delfino <gd...@gdsolutions.com.ve> on 2003/09/06 18:36:30 UTC

INSTALL

Hello all, I am new to this list.  I am writing because I want to help make
apache documentation better.  I think this is important as I have spent
many many hours trying to make and install my apache under FreeBSD
correctly (and I'm still trying).

My first comment is in regards to the INSTALL file.  It contains the
following text:

> There are currently two layouts pre-defined in the file
> config.layout: `Apache' for the classical Apache path layout and
> `GNU' for a path layout conforming to the GNU `standards' document.

This is false and leads to confusion.  If you open the config.layout file
you will find the following layouts:

<Layout Apache>
<Layout GNU>
<Layout BinaryDistribution>
<Layout Mac OS X Server>
<Layout Darwin>
<Layout RedHat>
<Layout opt>
<Layout beos>
<Layout SuSE>
<Layout BSDI>
<Layout Solaris>
<Layout FreeBSD>
<Layout OpenBSD>
<Layout Cygwin>

Therefore I would change that text to:



-----------------------------------------
There are many layouts pre-defined in the file
config.layout: `Apache' for the classical Apache path layout,
`GNU' for a path layout conforming to the GNU `standards' document, and
there are other you can see by using the command: 

grep "^<Layout" config.layout
-----------------------------------------



or we could actually show the names of the layout available:



-----------------------------------------
There are many layouts pre-defined in the file config.layout:
`Apache' for the classical Apache path layout.
`GNU' for a path layout conforming to the GNU `standards' document.
`BinaryDistribution'
`Mac OS X Server'
`Darwin'
`RedHat'
`opt'
`beos'
`SuSE'
`BSDI'
`Solaris'
`FreeBSD'
`OpenBSD'
`Cygwin'
-----------------------------------------


Please let me know what you think.  I have noe idea of how to make these
changes make it into the acual INSTALL file.

Regards,

Gustavo Delfino

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: INSTALL

Posted by Cliff Woolley <jw...@virginia.edu>.
On Sat, 6 Sep 2003, André Malo wrote:

> +     path base-layout. There are many layouts pre-defined in the file
> +     config.layout. Except on MacOS(X) configure defaults to the `Apache'
> +     classical path layout. You can get an overview of the existing layouts
> +     by using the command:
> +
> +     grep "^<Layout" config.layout
> +
> +     When you want to use your own custom layout FOO, either add a
> +     corresponding "<Layout FOO>...</Layout>" section
>       to config.layout and use --with-layout=FOO or place it into your own
>       file, say config.mypaths, and use --with-layout=config.mypaths:FOO.

Feel free to change what I wrote to this version if you like... either way
is fine with me.

--Cliff



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: INSTALL

Posted by Erik Abele <er...@codefaktor.de>.
On 06/09/2003, at 07:37, André Malo wrote:
>
> I see no reason to mention the GNU layout explicitly any longer. 
> Additionally
> the sentence before are not really correct, so I'd suggest to change 
> it that
> way:
>
> Index: INSTALL
> ===================================================================
> RCS file: /home/cvs/apache-1.3/INSTALL,v
> retrieving revision 1.67
> diff -u -r1.67 INSTALL
> --- INSTALL     6 Jun 2003 19:48:50 -0000       1.67
> +++ INSTALL     6 Sep 2003 17:31:43 -0000
> @@ -216,11 +216,15 @@
>                 chosen paths via the --layout option.
>
>       Use the --with-layout=[F:]ID option to select a particular 
> installation
> -     path base-layout. You always _HAVE_ to select a base-layout. 
> There are
> -     currently two layouts pre-defined in the file config.layout: 
> `Apache' for
> -     the classical Apache path layout and `GNU' for a path layout 
> conforming
> -     to the GNU `standards' document. When you want to use your own 
> custom
> -     layout FOO, either add a corresponding "<Layout 
> FOO>...</Layout>" section
> +     path base-layout. There are many layouts pre-defined in the file
> +     config.layout. Except on MacOS(X) configure defaults to the 
> `Apache'
> +     classical path layout. You can get an overview of the existing 
> layouts
> +     by using the command:
> +
> +     grep "^<Layout" config.layout
> +
> +     When you want to use your own custom layout FOO, either add a
> +     corresponding "<Layout FOO>...</Layout>" section
>       to config.layout and use --with-layout=FOO or place it into your 
> own
>       file, say config.mypaths, and use 
> --with-layout=config.mypaths:FOO.

+1.

>> or we could actually show the names of the layout available:
>
> I don't like that, since it's harder to maintain (as you see in the 
> current
> INSTALL document).

Yep, nobody will remember to update the INSTALL file when a new layout 
gets added, so please let's be a bit generic here.

>> Please let me know what you think.  I have noe idea of how to make 
>> these
>> changes make it into the acual INSTALL file.
>
> The best way to suggest changes is to use unified diffs. Once you have 
> a CVS
> checkout, you can modify the file, 'cvs diff -u', and send it as an 
> attachment
> (text/plain).

And, Gustavo, don't forget to read 
http://httpd.apache.org/docs-project/ if you haven't done so until now. 
Especially http://httpd.apache.org/docs-project/docsformat.html and 
also http://httpd.apache.org/dev/ will be helpful.

Cheers,
Erik

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: INSTALL

Posted by André Malo <nd...@perlig.de>.
* Gustavo Delfino wrote:

> Hello all, I am new to this list.  I am writing because I want to help make
> apache documentation better.  I think this is important as I have spent
> many many hours trying to make and install my apache under FreeBSD
> correctly (and I'm still trying).

Welcome!

> My first comment is in regards to the INSTALL file.  It contains the
> following text:
> 
>> There are currently two layouts pre-defined in the file
>> config.layout: `Apache' for the classical Apache path layout and
>> `GNU' for a path layout conforming to the GNU `standards' document.

Doh, right. This one is quite outdated.

> -----------------------------------------
> There are many layouts pre-defined in the file
> config.layout: `Apache' for the classical Apache path layout,
> `GNU' for a path layout conforming to the GNU `standards' document, and
> there are other you can see by using the command:
> 
> grep "^<Layout" config.layout
> -----------------------------------------

I see no reason to mention the GNU layout explicitly any longer. Additionally
the sentence before are not really correct, so I'd suggest to change it that
way:

Index: INSTALL
===================================================================
RCS file: /home/cvs/apache-1.3/INSTALL,v
retrieving revision 1.67
diff -u -r1.67 INSTALL
--- INSTALL     6 Jun 2003 19:48:50 -0000       1.67
+++ INSTALL     6 Sep 2003 17:31:43 -0000
@@ -216,11 +216,15 @@
                chosen paths via the --layout option.

      Use the --with-layout=[F:]ID option to select a particular installation
-     path base-layout. You always _HAVE_ to select a base-layout. There are
-     currently two layouts pre-defined in the file config.layout: `Apache' for
-     the classical Apache path layout and `GNU' for a path layout conforming
-     to the GNU `standards' document. When you want to use your own custom
-     layout FOO, either add a corresponding "<Layout FOO>...</Layout>" section
+     path base-layout. There are many layouts pre-defined in the file
+     config.layout. Except on MacOS(X) configure defaults to the `Apache'
+     classical path layout. You can get an overview of the existing layouts
+     by using the command:
+
+     grep "^<Layout" config.layout
+
+     When you want to use your own custom layout FOO, either add a
+     corresponding "<Layout FOO>...</Layout>" section
      to config.layout and use --with-layout=FOO or place it into your own
      file, say config.mypaths, and use --with-layout=config.mypaths:FOO.

> or we could actually show the names of the layout available:

I don't like that, since it's harder to maintain (as you see in the current
INSTALL document).

> Please let me know what you think.  I have noe idea of how to make these
> changes make it into the acual INSTALL file.

The best way to suggest changes is to use unified diffs. Once you have a CVS
checkout, you can modify the file, 'cvs diff -u', and send it as an attachment
(text/plain).

Thanks!

nd

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Re: INSTALL

Posted by Cliff Woolley <jw...@virginia.edu>.
On Sat, 6 Sep 2003, Gustavo Delfino wrote:

> > There are currently two layouts pre-defined in the file
> > config.layout: `Apache' for the classical Apache path layout and
> > `GNU' for a path layout conforming to the GNU `standards' document.
>
> This is false and leads to confusion.  If you open the config.layout file
> you will find the following layouts:

Indeed you are correct.  Fix committed.

Thanks!
Cliff

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org