You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@httpd.apache.org by Martin Kraemer <Ma...@fujitsu-siemens.com> on 2001/08/23 10:52:07 UTC

Location of /manual

In the configuration file, we have:

> #
> # This should be changed to the ServerRoot/htdocs/manual/.  The alias provides
> # the manual, even if you choose to move your DocumentRoot.  You may comment
> # this out if you do not care for the documentation.
> #
> Alias /manual "@@ServerRoot@@/htdocs/manual"
> 
> <Directory "@@ServerRoot@@/htdocs/manual/">
>     Options Indexes FollowSymLinks MultiViews

By doing it this way, we make it easy for end users to modify the
DocumentRoot to separate their contents from the manual's, but we
make it difficult if they choose to replace the contents in the
@@ServerRoot@@/htdocs directory directly.

I would propose to handle /manual quite similar to /icons as a read-only
resource which is part of the server, not part of the documentroot.

In other words, I propose to move /manual up one directoryy level,
side by side with /icons:
   @@ServerRoot@@/htdocs/...
   @@ServerRoot@@/icons/...
   @@ServerRoot@@/manual/...

Then we really don't need to worry about overwriting the /manual
directory during installation (we don't for /icons either, but we
have been careful with /htdocs at least in Apache 1.3).

Thanks to the Alias, no end-user-change is visible. but we get a
much better separation.

Your comments?

   Martin
-- 
<Ma...@Fujitsu-Siemens.com>    |       Fujitsu Siemens
       <ma...@apache.org>              |   81730  Munich,  Germany

Re: Location of /manual

Posted by Pier Fumagalli <pi...@betaversion.org>.
"Rodent of Unusual Size" <Ke...@Golux.Com> wrote:

> -1 for 1.3.  (Yes, that is a retroactive veto.)  It breaks
> checkout as it currently stands (which could be fixed), and
> certainly violates the Principle of Least Astonishment for
> people upgrading from 1.3.20 or earlier.

Thanks for bringing this up to the list Ken... As things stand, it's
impossible to have a "clean" checkout of the FULL apache-1.3 CVS tree,
unless you don't manually remove the checked out htdocs directory, check it
out from the httpd-docs-1.3 module, move it in the right place, and do a
"cvs update -Pd"...

Also, with the current CVS layout, it's impossible to check out builds prior
to 1.3.13 (if I'm not wrong, but that should be the version).

Files should have been copied on the server around before the first split
(and I realize that now, months later it'll be a mess). If someone knows how
to "merge" two CVS (RCS) ",v" files, that could be a solution...

    Pier


Re: Location of /manual

Posted by Rodent of Unusual Size <Ke...@Golux.Com>.
-1 for 1.3.  (Yes, that is a retroactive veto.)  It breaks
checkout as it currently stands (which could be fixed), and
certainly violates the Principle of Least Astonishment for
people upgrading from 1.3.20 or earlier.

+1 for 2.0.
-- 
#ken	P-)}

Ken Coar, Sanagendamgagwedweinini  http://Golux.Com/coar/
Author, developer, opinionist      http://Apache-Server.Com/

"All right everyone!  Step away from the glowing hamburger!"

Re: Location of /manual

Posted by "William A. Rowe, Jr." <wr...@rowe-clan.net>.
From: "Martin Kraemer" <Ma...@fujitsu-siemens.com>
Sent: Thursday, August 23, 2001 3:52 AM


> In the configuration file, we have:
> 
> > #
> > # This should be changed to the ServerRoot/htdocs/manual/.  The alias provides
> > # the manual, even if you choose to move your DocumentRoot.  You may comment
> > # this out if you do not care for the documentation.
> > #
> > Alias /manual "@@ServerRoot@@/htdocs/manual"
> > 
> > <Directory "@@ServerRoot@@/htdocs/manual/">
> >     Options Indexes FollowSymLinks MultiViews
> 
> By doing it this way, we make it easy for end users to modify the
> DocumentRoot to separate their contents from the manual's, but we
> make it difficult if they choose to replace the contents in the
> @@ServerRoot@@/htdocs directory directly.
> 
> I would propose to handle /manual quite similar to /icons as a read-only
> resource which is part of the server, not part of the documentroot.
> 
> In other words, I propose to move /manual up one directoryy level,
> side by side with /icons:
>    @@ServerRoot@@/htdocs/...
>    @@ServerRoot@@/icons/...
>    @@ServerRoot@@/manual/...

++1

> Then we really don't need to worry about overwriting the /manual
> directory during installation (we don't for /icons either, but we
> have been careful with /htdocs at least in Apache 1.3).
> 
> Thanks to the Alias, no end-user-change is visible. but we get a
> much better separation.

Agreed.  Make is so (even the Makefile.win change should be simple :)


Re: Location of /manual

Posted by Joshua Slive <jo...@slive.ca>.
On Thu, 23 Aug 2001, Martin Kraemer wrote:
>
> I would propose to handle /manual quite similar to /icons as a read-only
> resource which is part of the server, not part of the documentroot.
>

+1

Joshua.


Re: Location of /manual

Posted by Rich Bowen <rb...@rcbowen.com>.
On Thu, 23 Aug 2001, Martin Kraemer wrote:

> In other words, I propose to move /manual up one directoryy level,
> side by side with /icons:
>    @@ServerRoot@@/htdocs/...
>    @@ServerRoot@@/icons/...
>    @@ServerRoot@@/manual/...
>
> Then we really don't need to worry about overwriting the /manual
> directory during installation (we don't for /icons either, but we
> have been careful with /htdocs at least in Apache 1.3).

Ooh. What a great idea.

+1

-- 
Rich Bowen - rbowen@rcbowen.com
... and another brother out of his mind, and another brother out at New
York (not the same, though it might appear so)
	Somebody's Luggage (Charles Dickens)


Re: Location of /manual

Posted by "William A. Rowe, Jr." <wr...@rowe-clan.net>.
From: "Lars Eilebrecht" <la...@hyperreal.org>
Sent: Thursday, August 23, 2001 4:47 PM


> According to Martin Kraemer:
> 
> >  In other words, I propose to move /manual up one directoryy level,
> >  side by side with /icons:
> >     @@ServerRoot@@/htdocs/...
> >     @@ServerRoot@@/icons/...
> >     @@ServerRoot@@/manual/...
> 
> This makes sense, but then we should move htdocs/error/ one
> level up, too. IMHO the server root gets cluttered up more and more
> if we do this.

I already did (no?)  /error/ was clearly along the same lines as /icon/.
But I agree with Martin, folks are more than likely to up and blow away
htdocs and start clean (with unexpected side effects.)  Least surprize.

> How about an additional directory like 'apdocs' for the manual,
> icons and error docs? It could be used by other third-party modules
> as well for storing manuals or other documents.

Hmmm... no.  /icons/ and /error/ are manditory if those parts are installed.
/manual/ is in the 'nice to have' list, and it deserves it's own spot.

If we avoided ap'docs' and made it apcontent or apfiles, well that I might 
be able to buy into.  apdocs sounds disposable.


RE: Location of /manual

Posted by Joshua Slive <sl...@commerce.ubc.ca>.
On Thu, 23 Aug 2001, Lars Eilebrecht wrote:
>
> This makes sense, but then we should move htdocs/error/ one
> level up, too. IMHO the server root gets cluttered up more and more
> if we do this.

OtherBill already moved the error directory.

Joshua.


RE: Location of /manual

Posted by Lars Eilebrecht <la...@hyperreal.org>.
According to Martin Kraemer:

>  In other words, I propose to move /manual up one directoryy level,
>  side by side with /icons:
>     @@ServerRoot@@/htdocs/...
>     @@ServerRoot@@/icons/...
>     @@ServerRoot@@/manual/...

This makes sense, but then we should move htdocs/error/ one
level up, too. IMHO the server root gets cluttered up more and more
if we do this.

How about an additional directory like 'apdocs' for the manual,
icons and error docs? It could be used by other third-party modules
as well for storing manuals or other documents.

ciao...
-- 
Lars Eilebrecht               - Oregano: The ancient Italian art of
lars@hyperreal.org                              pizza folding.